Skip to content
Select themeSelect language

`POST /api/v1/billing/checkout` — open a Stripe Checkout session for a plan against the caller's workspace, returning the hosted-checkout session id/url.

POST
/api/v1/billing/checkout
curl --request POST \
--url https://example.com/api/v1/billing/checkout \
--header 'Content-Type: application/json' \
--data '{ "cancel_url": "example", "plan_id": "example", "success_url": "example", "workspace_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" }'
Media typeapplication/json
object
cancel_url
required
string
plan_id
required
string
success_url
required
string
workspace_id
required
string format: uuid
Examplegenerated
{
"cancel_url": "example",
"plan_id": "example",
"success_url": "example",
"workspace_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
}
Media typeapplication/json
object
id
required
string
url
required
string
Examplegenerated
{
"id": "example",
"url": "example"
}