Create a Stripe Checkout session — createcheckoutsession

POST

/stripe/checkout

const url = 'https://example.com/api/stripe/checkout';
const options = {
  method: 'POST',
  headers: {
    cookie: 'sb-access-token=<sb-access-token>',
    'Content-Type': 'application/json'
  },
  body: '{"plan":"example","priceId":"example"}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request POST \
  --url https://example.com/api/stripe/checkout \
  --header 'Content-Type: application/json' \
  --cookie sb-access-token=<sb-access-token> \
  --data '{ "plan": "example", "priceId": "example" }'

Authorizations

cookieAuth

Request Body

application/json

object

plan

Plan name (e.g., pro, team)

string

priceId

Stripe price ID (alternative to plan)

string

Responses

200

Checkout session URL

application/json

object

url

required

string format: uri

400

Invalid request

application/json

object

error

required

Human-readable error message

string

code

Stable machine-readable error code for client branching

string

fieldErrors

First validation message per field path

object

key

additional properties

string

issues

Structured validation issues (Zod)

Array<object>

object

path

required

string

message

required

string

retryAfter

Seconds until rate limit resets (429 responses)

number

401

Not authenticated

application/json

object

error

required

Human-readable error message

string

code

Stable machine-readable error code for client branching

string

fieldErrors

First validation message per field path

object

key

additional properties

string

issues

Structured validation issues (Zod)

Array<object>

object

path

required

string

message

required

string

retryAfter

Seconds until rate limit resets (429 responses)

number

reconnect

True if re-linking GitHub may fix the issue

boolean

409

Resource state conflict

application/json

object

error

required

Human-readable error message

string

code

Stable machine-readable error code for client branching

string

fieldErrors

First validation message per field path

object

key

additional properties

string

issues

Structured validation issues (Zod)

Array<object>

object

path

required

string

message

required

string

retryAfter

Seconds until rate limit resets (429 responses)

number