Skip to main content
POST
Change the plan

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

X-Ankra-Organisation-Id
string<uuid>

Act in another organisation the token's owner is an active member of; defaults to the token's own organisation.

Body

application/json

success_url and cancel_url must be on the platform origin; they default to the organisation's billing page.

plan_name
string
required
billing_cycle
string
default:monthly

monthly or annual

success_url
string | null
cancel_url
string | null

Response

The outcome, with a Checkout URL when one is needed

status
string
required
checkout_url
string | null
required
message
string | null
required