Skip to main content

Billing

POST/v1/billing/change-plan

Change Plan Route

Change subscription plan. Upgrades apply immediately with proration; downgrades defer to period end.

Bearer tokenscope: org memberoperation_id: billing.changePlan

Authentication

Send Authorization: Bearer <token>. Admin token — create via POST /v1/orgs/{org_id}/tokens/admin. Org-wide scope, so keep it tightly held. Requests without a valid credential are rejected with 401.

SDK install

pip install znyx-sdknpm install @znyx/sdk

Code samples

Request

curl -X POST "$ZNYX_API_URL/v1/billing/change-plan?plan=string" \
  -H "Authorization: Bearer $ZNYX_TOKEN"

Response

application/json

Successful Response

null

Schema: any

Query parameters

NameTypeRequiredDescription
plan#querystringrequired-

Responses

StatusDescription
200Successful Response
422Validation Error

Response schema

any

Errors & what triggers them

CodeTriggerFix
401Missing or expired Authorization header.-
403Token does not have the required role (admin / editor).-
404Target resource does not exist in this org.-
422Request body failed validation.-