Skip to content
StartupBuilder
by startups.studio
by Startups.Studio
Code
Changelog
APIProductWhat you sellOffer

Offer routes: accept, grant, publish, subscribe

The Offer Verbs accept, grant, publish, subscribe as api.sb routes, with inputs, result, refusals and an example.

Reference for Offer, one group of Offer routes.

Offer.accept

Accept records that a party takes an Offer, which makes that party a Customer of the Startup. Verb page.

Text
POST /{namespace}/offers/{offer}/accept

Path: offer. Body, as JSON: the other inputs. Emits Offer.accepted.

Inputs

InputTypeRequiredDescription
offerOfferrequiredThe Offer to accept.
partystringrequiredThe person or organization accepting.

Returns

OutputTypeRequiredDescription
customerCustomerrequiredThe Customer the party is or becomes.
offerOfferrequiredThe Offer accepted.

Refuses when

CheckErrorFixThen call
The operation is part of an Offer the caller has not accepted or paid for.payment-requiredAccept the Offer named in the response, then retry the call.None.
The key is valid, but its scopes do not allow this operation.forbiddenUse a key whose scopes cover the operation, or ask an owner of the namespace to grant them.None.
The record is not in a state that allows this Verb, so the call is refused.refusedRead the record, run the Verb that moves it to an allowed state, then retry.None.

Example

Terminal
curl -X POST https://api.sb/leaseline.app/offers/offer_2hzYe1ERo0/accept \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"party":"Pinecrest Homes"}'
JSON
{
  "api": "https://api.sb/leaseline.app",
  "customer": {
    "$id": "https://api.sb/leaseline.app/customers/cus_Gp5HXPKk00",
    "$type": "Customer",
    "since": "2026-10-22T12:00:00Z"
  },
  "offer": {
    "$id": "https://api.sb/leaseline.app/offers/offer_2hzYe1ERo0",
    "$type": "Offer",
    "price": {
      "amount": 29,
      "currency": "USD"
    }
  },
  "action": {
    "$id": "https://api.sb/leaseline.app/actions/act_br07HsG8MG",
    "operation": "Offer.accept",
    "status": "done"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/actions/act_br07HsG8MG"
  }
}

Offer.grant

Grant adds an Entitlement to an Offer: a Verb its Customers may call, optionally bounded by a Limit. Verb page.

Text
POST /{namespace}/offers/{offer}/grant

Path: offer. Body, as JSON: the other inputs. Emits Offer.granted.

Inputs

InputTypeRequiredDescription
offerOfferrequiredThe Offer that grants it.
verbVerbrequiredThe Verb its Customers may call, as Noun.verb.
limitLimitThe Limit that bounds it. Unset: a feature, called as often as the Customer likes.

Returns

OutputTypeRequiredDescription
entitlementEntitlementrequiredThe new Entitlement, granted by the Offer.
offerOfferrequiredThe Offer, with the Entitlement added.

Refuses when

CheckErrorFixThen call
The key is valid, but its scopes do not allow this operation.forbiddenUse a key whose scopes cover the operation, or ask an owner of the namespace to grant them.None.

Example

Terminal
curl -X POST https://api.sb/leaseline.app/offers/offer_2hzYe1ERo0/grant \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"verb":"verb_hlkWBvrAyZ"}'
JSON
{
  "api": "https://api.sb/leaseline.app",
  "entitlement": {
    "$id": "https://api.sb/leaseline.app/entitlements/ent_7MQACmrzGj",
    "$type": "Entitlement",
    "verb": "verb_hlkWBvrAyZ"
  },
  "offer": {
    "$id": "https://api.sb/leaseline.app/offers/offer_2hzYe1ERo0",
    "$type": "Offer",
    "price": {
      "amount": 29,
      "currency": "USD"
    }
  },
  "action": {
    "$id": "https://api.sb/leaseline.app/actions/act_br07HsG8MG",
    "operation": "Offer.grant",
    "status": "done"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/actions/act_br07HsG8MG"
  }
}

Offer.publish

Publish makes an Offer available for parties to accept. Verb page.

Text
POST /{namespace}/offers/{offer}/publish

Path: offer. Emits Offer.published.

Inputs

InputTypeRequiredDescription
offerOfferrequiredThe Offer to publish.

Returns

OutputTypeRequiredDescription
offerOfferrequiredThe Offer, now open to accept.

Refuses when

CheckErrorFixThen call
A Service Offer promises a remedy or a pricing basis that its Service’s checks cannot back.contract-unsupportedAdd a stronger check to the Service’s steps, or offer a cheaper remedy or basis, then publish again.None.
The key is valid, but its scopes do not allow this operation.forbiddenUse a key whose scopes cover the operation, or ask an owner of the namespace to grant them.None.
The record is not in a state that allows this Verb, so the call is refused.refusedRead the record, run the Verb that moves it to an allowed state, then retry.None.
The median Customer’s Cost leaves less than the Startup’s target margin at this Price.below-contribution-floorRaise the Price to the floor the error names, or grant fewer Entitlements.Offer.update

Example

Terminal
curl -X POST https://api.sb/leaseline.app/offers/offer_2hzYe1ERo0/publish \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY"
JSON
{
  "api": "https://api.sb/leaseline.app",
  "offer": {
    "$id": "https://api.sb/leaseline.app/offers/offer_2hzYe1ERo0",
    "$type": "Offer",
    "price": {
      "amount": 29,
      "currency": "USD"
    }
  },
  "action": {
    "$id": "https://api.sb/leaseline.app/actions/act_br07HsG8MG",
    "operation": "Offer.publish",
    "status": "done"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/actions/act_br07HsG8MG"
  }
}

Offer.subscribe

Subscribe accepts a recurring Offer as a Subscription that renews each period until it ends. Verb page.

Text
POST /{namespace}/offers/{offer}/subscribe

Path: offer. Body, as JSON: the other inputs. Emits Offer.subscribed.

Inputs

InputTypeRequiredDescription
offerOfferrequiredThe recurring Offer.
quantityintegerSeats or units. Defaults to 1.
promotionCodestringA promotion code the buyer typed; applies its Coupon for the Coupon’s duration.

Returns

OutputTypeRequiredDescription
subscriptionSubscriptionrequiredThe new Subscription.
offerOfferrequiredThe Offer subscribed to.

Refuses when

CheckErrorFixThen call
The input does not match the schema of the operation.invalid-inputRead the schema of the operation, then send every required field with the right type.None.
The operation is part of an Offer the caller has not accepted or paid for.payment-requiredAccept the Offer named in the response, then retry the call.Offer.accept
The key is valid, but its scopes do not allow this operation.forbiddenUse a key whose scopes cover the operation, or ask an owner of the namespace to grant them.None.
The record is not in a state that allows this Verb, so the call is refused.refusedRead the record, run the Verb that moves it to an allowed state, then retry.None.

Example

Terminal
curl -X POST https://api.sb/leaseline.app/offers/offer_2hzYe1ERo0/subscribe \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY"
JSON
{
  "api": "https://api.sb/leaseline.app",
  "subscription": {
    "$id": "https://api.sb/leaseline.app/subscriptions/sub_jpvy3zejKB",
    "$type": "Subscription",
    "status": "active"
  },
  "offer": {
    "$id": "https://api.sb/leaseline.app/offers/offer_2hzYe1ERo0",
    "$type": "Offer",
    "price": {
      "amount": 29,
      "currency": "USD"
    }
  },
  "action": {
    "$id": "https://api.sb/leaseline.app/actions/act_br07HsG8MG",
    "operation": "Offer.subscribe",
    "status": "done"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/actions/act_br07HsG8MG"
  }
}

update, delete

Previous

trial, withdraw

Next