Start buying credits or a monthly plan
start_credit_checkoutDestructive
Opens a payment page and returns its URL. Nothing is charged until the buyer pays on that page. It sells one credit pack, a monthly plan (offer team, with teamPlan starter or scale, a subscription that renews until cancelled), or extra credits for a workspace already on a plan (offer team_credits, for quantity credits at that plan's own price per credit, paid once, expiring with the plan month). Only a workspace on a plan can use team_credits. Only owners and admins can open a page. The server refuses the request while startNow is false, and the same idempotencyKey returns the same page.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| offer | Yes | A pack, team or team_credits, from list_credit_offers. | |
| quantity | No | Credits for team_credits, within the range list_credit_offers gives; omit for a pack or a plan. | |
| startNow | Yes | Records the buyer's own consent to start the credits at once, during the withdrawal period, against this text: "Start my credits now, so they can be used during the 14-day withdrawal period. If I withdraw, I pay for the credits I used; I lose the right to withdraw once all the credits I am buying are used." The server refuses the request while it is false. | |
| teamPlan | No | The plan to start, for offer team only: starter or scale, from list_credit_offers. | |
| idempotencyKey | No | Reuse on retry to get the same page back. |