SOsolvapay
Activation

Activate a plan for a customer

Changed on

Activates a specific plan on a product for a customer. Usage-based plans (metered, no billing cycle) and free plans activate immediately. A zero credit balance is not an activation gate — empty-wallet access is enforced later as topup_required at usage time. Paid recurring, hybrid, or one-time plans return payment_required.

post/v1/sdk/activate

Request

Request body

customerRefstring required
planRefstring required
productRefstring required

Response

Plan activation result

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

Changes

  • aacdf8ae7816Revision changes
    • warning

      added the new already_purchased enum value to the response property for the response status

  • bbc2ff2bc849Revision changes
    • warning

      the request property's maxLength was set to 20

    • warning

      the request property's maxLength was set to 20

    • warning

      the request property's maxLength was set to 20