Sign in
Activation

Activate a plan for a customer

Activates a specific plan on a product for a customer. Usage-based (PAYG) plans activate eagerly (returning an active purchase so the SDK can proceed to the top-up step), while free, recurring, and hybrid plans keep strict semantics and may return payment_required or topup_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

Changes