Skip to main content
POST
Activate a plan for a customer

Authorizations

Authorization
string
header
required

Provider secret API key (sk_live_… / sk_test_…) supplied as a Bearer token.

Body

application/json
customerRef
string
required
Maximum string length: 20
planRef
string
required
Maximum string length: 20
productRef
string
required
Maximum string length: 20

Response

200 - application/json

Plan activation result

status
enum<string>
required
Available options:
activated,
already_active,
topup_required,
payment_required,
invalid
checkoutSessionId
string
checkoutUrl
string
creditBalance
number
creditsPerUnit
number
currency
string
message
string
purchaseRef
string