Skip to main content
POST
/
plan
/
upgrade
Upgrade Plan
curl --request POST \
  --url https://api.example.com/plan/upgrade
Changes the current organization plan. Depending on billing state, Mosaic may return a checkout URL to complete the change.

​
Request

curl -X POST "https://api.mosaic.so/plan/upgrade" \
  -H "Authorization: Bearer mk_your_api_key" \
  -H "Content-Type: application/json" \
  -d '{
    "plan_id": "professional_annual"
  }'

​
Body Parameters

FieldTypeRequiredDescription
plan_idstringYesTarget purchasable plan ID (creator, creator_annual, professional, professional_annual, or pro).
success_urlstringNoOverride checkout success redirect URL.
cancel_urlstringNoOverride checkout cancel redirect URL.

​
Response (Immediate Change)

{
  "success": true,
  "requires_checkout": false,
  "plan_id": "professional_annual",
  "plan_family": "professional"
}

​
Response (Checkout Required)

{
  "success": false,
  "requires_checkout": true,
  "checkout_url": "https://billing.autumn.com/checkout/...",
  "plan_id": "professional_annual"
}