Skip to main content
POST
Create an upgrade checkout session (redirects to direct API)
This endpoint requires authentication. Include your Bearer token in the Authorization header.

Description

POST /billing/upgrade/checkout-session Historical Free→Paid checkout-session flow. Currently always responds 200 with status: "redirect" and instructs the caller to use PUT /billing/stripe/change-plan directly instead — this is required to correctly bill outstanding metered usage during plan changes. No Stripe checkout session is actually created by this endpoint. Authorization:
  • Required role: owner only

Code Examples

Authorizations

Authorization
string
header
required

JWT Authorization header using the Bearer scheme. Format: "Bearer {token}"

Body

application/json
targetPlanLookupKey
string
required
Example:

"plus_monthly"

Response

Redirect instruction to use the direct subscription-update API

status
string
Example:

"redirect"

message
string
data
object