Skip to main content
POST
Start a plan checkout session

Authorizations

Authorization
string
header
required

Dashboard JWT token from Clerk

Body

application/json
planId
string
required

Identifier of the plan the customer is upgrading to.

Minimum string length: 1
successUrl
string<uri>
required

Trusted Orbit URL to redirect to after successful payment.

cancelUrl
string<uri>
required

Trusted Orbit URL to redirect to if the customer cancels.

priceId
string

Optional explicit Stripe price id; derived from planId when omitted.

Minimum string length: 1

Response

200 - application/json

Checkout session created; redirect the customer to checkoutUrl.

data
object
meta
object