Cookbook: Recurring Billing

Bill customers on a interval using recurring paylinks and subscription webhooks.

1. Prerequisites

Same as Cookbook: Sell a Product: settlement, API key, verified webhooks.

2. Create a recurring offer

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

Share the checkout URL. See Subscriptions.

3. Provision access from webhooks

Event	Merchant action
`Subscription.Created`	Record pending subscription
`Subscription.Updated` (Active)	Grant product access
`Payment.Updated` (Succeeded)	Confirm paid period
`Invoice.Created`	Record open invoice
`Invoice.Overdue`	Notify customer / restrict access per your policy
`Subscription.Canceled`	Revoke access

Always Verify Webhook Signatures and enforce idempotency on subscription and invoice ids.

4. Cancel

Use the Merchants API cancel-subscription endpoints (see API reference) or customer-facing cancel flows if enabled. Expect a cancellation webhook when status settles.

5. Ops

Use Event History and Replay if renewal notifications failed to reach your servers.

Get Started

Dashboard

Settlement

Payments

Deposit Accounts

Trading

Webhooks

Integrations

Pricing and Policies

Cookbook: Recurring Billing

1. Prerequisites

2. Create a recurring offer

3. Provision access from webhooks

4. Cancel

5. Ops

​1. Prerequisites

​2. Create a recurring offer

​3. Provision access from webhooks

​4. Cancel

​5. Ops

1. Prerequisites

2. Create a recurring offer

3. Provision access from webhooks

4. Cancel

5. Ops