Billing
This section describes Billing webhooks, which are only applicable for API version 2025-06-16 and later.
| Web app Label | Event Type | Description |
|---|---|---|
| Subscription -> Created | subscription.created | A subscription has been created. |
| Subscription -> In trial | subscription.in_trial | The subscription transits to IN_TRIAL status. |
| Subscription -> Active | subscription.active | The subscription transits to ACTIVE status. |
| Subscription -> Unpaid | subscription.unpaid | The subscription transits to UNPAID status. |
| Subscription -> Modified | subscription.modified | The subscription is updated. |
| Subscription -> Cancelled | subscription.cancelled | The subscription has been cancelled. |
| Invoice -> Created | invoice.created | The invoice has been created. |
| Invoice -> Finalized | invoice.finalized | The invoice has been finalized. |
| Invoice -> Voided | invoice.voided | The invoice has been voided. |
| Invoice -> Paid | invoice.payment.paid | The invoice has been paid. |
| Billing Transaction -> Created | billing_transaction.created | The Billing Transaction has been created. |
| Billing Transaction -> Succeeded | billing_transaction.succeeded | The Billing Transaction has succeeded. |
| Billing Transaction -> Cancelled | billing_transaction.cancelled | The Billing Transaction has been cancelled. |
This section describes the Billing webhook, which are only applicable for API version 2025-04-25 and before.
| Web app Label | Event Type | Description |
|---|---|---|
| Subscription -> Created | subscription.created | A subscription has been created. |
| Subscription -> Updated | subscription.updated | The subscription has been changed, such as status update, trial start & end, cancel at period end, etc. |
| Subscription -> Cancelled | subscription.cancelled | The subscription has been cancelled. |
| Invoice -> Sent | invoice.sent | The invoice is ready to be paid. |
| Invoice -> Paid | invoice.paid | The invoice has been paid successfully. |
| Invoice -> Payment failed | invoice.payment_failed | The invoice is marked as PAYMENT_FAILED and should be treated as bad debt in the accounting process. |
| Invoice -> Payment attempt failed | invoice.payment_attempt_failed | A payment attempt on the invoice failed. |
Was this page helpful?