latestOpenAPI 3.1.0MIT2026-08-22113168358.0 KB

2d06ad0e0bc3

Billing

Create Upgrade Link

Create a Stripe link the account owner opens in a browser to upgrade or manage their subscription. Nothing is charged by this call. Pass a plan to get a checkout link for that plan; existing subscribers may get an in-place plan change or a billing portal link instead. Omit plan to get a billing portal link for existing Stripe customers (returns 400 otherwise). Requires API key with billing:write permission.

post/v1/billing/upgrade-link

Request body

plan'basic' | 'premium' | 'business' | 'basic_annual' | 'premium_annual' | 'business_annual'

Target plan for a checkout link. Omit to get a billing portal link for existing Stripe customers.

Response

Billing link created

successboolean required
errorstring nullable