Start a Stripe Checkout session for a plan

`starter` (Free) without a tester code returns `400 BILLING_PLAN_NOT_PURCHASABLE`; start Free with `POST /billing/free/start`. A tester code's own plan always wins.

POST /billing/checkout/session

Headers

Authorization string Required
Bearer <session token>: the signed-in user’s Scaffold session token.
x-org-id string Required

Body

plan string
One of starter professional team
seats integer
Team plan only; every other plan is always 1 seat.
successPath string
Default /review
cancelPath string
Default /onboarding
testerAccessCode string

cURL Node Python

curl -X POST "https://api.scaffoldyourdocs.com/billing/checkout/session" \
  -H "Authorization: Bearer <session token>" \
  -H "x-org-id: org_example" \
  -H "Content-Type: application/json" \
  -d '{"plan":"professional","seats":1}'

const response = await fetch("https://api.scaffoldyourdocs.com/billing/checkout/session", {
  method: "POST",
  headers: {
    "Authorization": "Bearer <session token>",
    "x-org-id": "org_example",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({"plan":"professional","seats":1})
});

import requests

response = requests.post(
    "https://api.scaffoldyourdocs.com/billing/checkout/session",
    headers={
        "Authorization": "Bearer <session token>",
        "x-org-id": "org_example",
        "Content-Type": "application/json"
    },
    json={"plan": "professional", "seats": 1},
)