Skip to main content
POST
/
v1
/
sdk
/
activate
cURL
curl --request POST \
  --url https://api.example.com/v1/sdk/activate \
  --header 'Content-Type: application/json' \
  --data '
{
  "customerRef": "<string>",
  "productRef": "<string>",
  "planRef": "<string>"
}
'
{
  "status": "activated",
  "purchaseRef": "<string>",
  "message": "<string>",
  "creditBalance": 123,
  "creditsPerUnit": 123,
  "currency": "<string>",
  "checkoutUrl": "<string>",
  "checkoutSessionId": "<string>"
}

Body

application/json
customerRef
string
required
productRef
string
required
planRef
string
required

Response

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