Subscriptions

​

Flow

1. Create a recurring plan/paylink (type: Recurring, interval, intervalCount)
2. Customer completes the first checkout
3. Platform issues invoices on schedule
4. You handle Subscription.* and Invoice.* webhooks

​

Create a recurring paylink

curl -X POST "https://mapi.zbx.boomfi.xyz/v1/paylinks" \
  -H "X-API-KEY: sk_test_xxx" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Premium membership",
    "amount": "69.99",
    "currency": "USD",
    "type": "Recurring",
    "interval": "Month",
    "intervalCount": 1,
    "reference": "plan_premium_monthly"
  }'

​

Plans API

• GET https://mapi.zbx.boomfi.xyz/v1/plan
• POST https://mapi.zbx.boomfi.xyz/v1/plan
• GET https://mapi.zbx.boomfi.xyz/v1/plan/{id}

​

Subscriptions API

• GET https://mapi.zbx.boomfi.xyz/v1/subscriptions: list
• GET https://mapi.zbx.boomfi.xyz/v1/subscriptions/{customerID}: list by customer
• POST https://mapi.zbx.boomfi.xyz/v1/subscriptions/{subscriptionID}/invoices: create invoice
• Cancel / delete flows as documented in the API reference under Subscriptions

​

Events to handle

​

Cookbook