Initiate subscription checkout

POST

//workspace/subscription/checkout

Creates a hosted checkout session for the requested plan. Returns a checkout_url that the client
(browser or mobile app) should open. Subscription activation only happens after server-side confirmation
via webhooks or provider retrieval; the return URL alone does not activate a subscription.
Canonical idempotency is the Idempotency-Key header only. Body keys are ignored.

Request

Authorization

Bearer Token

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Header Params

Body Params application/jsonRequired

Examples

Responses

🟢200CheckoutResponse

application/json

Pending checkout session

Bodyapplication/json

🟠401Unauthenticated

🟠403Forbidden

🟠409Conflict

🟠422ValidationError

🟠429TooManyRequests

Request Example

Shell

JavaScript

Java

Swift

curl --location '//workspace/subscription/checkout' \
--header 'Idempotency-Key;' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
    "plan": "string",
    "return_url": "http://example.com",
    "cancel_url": "http://example.com"
}'

Response Example

200 - Example 1

{
    "data": {
        "checkout_url": "http://example.com",
        "payment_id": "string",
        "provider": "string",
        "expires_at": "2019-08-24T14:15:22.123Z",
        "idempotency_key": "string",
        "status": "pending"
    }
}

Modified at 2026-08-18 22:47:00

Current workspace subscription

Change subscription plan