v20

latestOpenAPI 3.0.0raw.githubusercontent.com2026-07-214885191.3 KB
Activation

Activate a plan for a customer

Activates a specific plan on a product for a customer. Usage-based (PAYG) plans are topup-first: a zero-balance customer receives topup_required and only activates after a successful top-up, while free plans activate immediately and paid recurring / hybrid plans return payment_required.

post/v1/sdk/activate

Request body

customerRefstring required
planRefstring required
productRefstring required

Response

Plan activation result

checkoutSessionIdstring
checkoutUrlstring
creditBalancenumber
creditsPerUnitnumber
currencystring
messagestring
purchaseRefstring
status'activated' | 'already_active' | 'topup_required' | 'payment_required' | 'invalid' required
All 48 operations