Offer routes: trial, withdraw

Reference for Offer, one group of Offer routes.

Offer.trial

Trial starts a Customer on an Offer free for a set number of days, with or without a card, converting or ending by its terms. Verb page.

Text

POST /{namespace}/offers/{offer}/trial

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

Inputs

Input	Type	Required	Description
`offer`	Offer	required	The Offer to try.
`customer`	Customer	required	The Customer who tries it.
`days`	`integer`	required	How long the trial runs. Never randomized.
`card`	`boolean`		True to take a card up front and charge it when the trial ends.

Returns

Output	Type	Required	Description
`subscription`	Subscription	required	The Subscription, free until the trial ends.
`offer`	Offer	required	The Offer the trial is on.

Refuses when

Check	Error	Fix	Then call
The key is valid, but its scopes do not allow this operation.	`forbidden`	Use 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/trial \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"customer":"cus_K1BROJhqzZ","days":1}'

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.trial",
    "status": "done"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/actions/act_br07HsG8MG"
  }
}

Offer.withdraw

Withdraw closes a published Offer to new Customers and leaves every existing Order and Subscription in force. Verb page.