Start Checkout for an add-ons package

posthttps://api.expiryedge.com/v1/addonsCheckout
admin60/minAny method
Request
curl -X POST 'https://api.expiryedge.com/v1/addonsCheckout' \
  -H "Authorization: Bearer $EXPIRYEDGE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "period": "month",
  "items": {
    "expiries": 2,
    "teams": 1
  },
  "sms_credit_blocks": 1,
  "return_url": "/dashboard/addons"
}'
Response
{
  "url": "https://checkout.stripe.com/c/pay/cs_live_e5F6g7H8",
  "sessionId": "cs_live_e5F6g7H8"
}

Creates a Stripe Checkout session for add-on units (recurring) and/or SMS/WhatsApp credit blocks (one-time). Max 100 units per item and 200 SMS blocks per request. Use addonsUpdate once a package exists (409 otherwise).

Body parameters

application/json
  • periodstring
    AllowedmonthyearDefault month
  • itemsmap of integer
    Map of add-on key to number of units (0-100).
  • sms_credit_blocksinteger
    min: 0 · max: 200
  • return_urlstring
    App-relative path to return to (must start with /). Default /dashboard/addons.

Returns

201
Checkout session created; redirect to url.
  • urlstringrequired
    format: uri
  • sessionIdstringrequired

Errors

400
The request is missing required fields or contains invalid values.
401
Missing, expired or invalid bearer token.
403
Authenticated, but your role or organization does not allow this action.
409
The organization already has an active add-ons package (code: ALREADY_HAS_ADDONS).
429
Too many requests for this endpoint from your IP. Wait Retry-After seconds.
500
Unexpected server error. Retry later; quote requestId to support.