Subscription Webhooks
This request updates the merchant about statuses of their shoppers' subscriptions. The subscriptions' related events are:
subscription_createdsubscription_renewedsubscription_canceledsubscription_pausedsubscription_unpausedsubscription_payment_failedsubscription_ended
Also see API for managing webhooks for more details
Authorization
X-API-Key X-API-Key<token>
In: header
Header Parameters
X-Bolt-Hmac-Sha256?string
Signed HMAC for hook verification
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
curl -X POST "https://example.com/webhooks_subscriptions" \ -H "Content-Type: application/json" \ -d '{ "type": "subscription_created", "object": "subscription", "data": { "id": "s_ABC123DEF456", "created_at": "2025-11-01T11:34:23.267804Z", "updated_at": "2025-11-01T11:34:23.267804Z", "merchant_name": "Example Merchant", "consumer_id": 12345678, "email": "customer@example.com", "total_amount": { "amount": 7088, "currency": "USD", "currency_symbol": "$" }, "status_details": { "type": "active" }, "payment_method": { "card_last_4": "1234", "card_network": "Visa" }, "next_renewal_date": "2025-12-01T12:03:23.267804Z", "plan": { "id": "spl_ABC123456789", "name": "Monthly Subscription", "sku": "sku_sample123", "created_at": "2025-10-31T08:12:32.429044Z", "updated_at": "2025-10-31T08:12:32.429044Z", "frequency": 1, "product_id": "sp_DEF456GHI789", "frequency_unit": "month" }, "order": { "id": "so_ABC123DEF456", "sequence_number": 1, "subscription_id": "s_XYZ789ABC123", "transaction_reference": "ABCD-EFGH-IJKL", "placement_time": "2025-11-01T13:20:18.433474Z", "status": "done", "created_at": "2025-11-01T11:34:23.267804Z", "updated_at": "2025-11-01T11:34:23.267804Z", "total_amount": { "amount": 7088, "currency": "USD", "currency_symbol": "$" } }, "product_names": [ "Sample Product" ], "metadata": { "key1": "value1" } } }'{ "status": "succeeded"}