Subscriptions

Manage payer subscriptions to your catalog products via the merchant API.

Operations

Both are wired on {docsEnv.apiBaseUrl}.

List subscriptions

Code
curl -s -X POST "{docsEnv.apiBaseUrl}/LIST_MERCHANT_SUBSCRIPTIONS" \
  -H "Authorization: Bearer YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{"limit": 50, "status": "active"}'

Ensure your API key includes read:subscriptions (or a template that grants it). Keys with empty scopes return 403 INSUFFICIENT_SCOPE.

Cancel a subscription

Cancellation is idempotency-recommended — send an Idempotency-Key header when retrying:

Code
curl -s -X POST "{docsEnv.apiBaseUrl}/CANCEL_MERCHANT_SUBSCRIPTION" \
  -H "Authorization: Bearer YOUR_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: cancel-sub-001" \
  -d '{"id": "merchant_subscription_uuid"}'

Requires cancel:subscription. Live keys may prompt confirmation in the dashboard Arena for money-adjacent flows — see Idempotency.

Webhook events

Subscription lifecycle events (subscription.created, subscription.updated, subscription.cancelled) are delivered via merchant webhooks configured in the dashboard — not via these API calls. See Webhook events and Webhooks.

Next steps

• Idempotency — before cancel retries
• Webhook events — payload catalog
• API Reference