subscription.status_changed
Sent whenever a subscription changes status: the customer agrees and it becomes active or trialing, they decline or never answer, you or iSmartPay pause or cancel it, a cycle goes past due, or it completes. It is also sent, with the status unchanged, when you set a subscription to end at its period end; cancelAtPeriodEnd is then true. A past_due event is sent for a subscription with pastDueBehavior keep_charging too; read the subscription to see it as unpaid. Needs mandates.read to appear in the events list. Answer with any 2xx within 10 seconds. Anything else, a timeout or a redirect is retried up to 6 times over about a day. Events can arrive out of order, so compare statuses and cycles rather than trusting arrival order.
subscription.status_changedWebhookWebhook-IdstringrequiredThe event id. The same event can arrive more than once; use this to ignore repeats.
Webhook-TimestampstringrequiredUnix seconds when this attempt was signed. Reject a delivery older than 5 minutes.
Webhook-Signaturestringrequiredv1, then a comma, then the base64 HMAC-SHA256 of "{Webhook-Id}.{Webhook-Timestamp}.{raw body}" keyed with your endpoint's signing secret. Compare in constant time.
application/jsonidstringrequiredThe event id, the same as the Webhook-Id header.
typestringrequiredcreatedAtstring<date-time>requiredWhen the change happened.
dataSubscriptionEventDatarequiredA subscription as it stood when the event happened. It carries the fields that changed with it; read the subscription for the rest, such as fee and totalAmount.
Show propertiesHide properties
idstringrequiredreferencestringrequiredstatusstringrequiredincompleteincomplete_expiredtrialingactivepast_duepausedcanceledcompletedpreviousStatusstringAbsent on subscription.created.
incompleteincomplete_expiredactivepast_duepausedcanceledcompletedpaymentMethodstringrequiredmobile_moneywalletcustomerobjectrequiredShow propertiesHide properties
networkstringmtntelecelamountstringrequiredA decimal string in major units, before the fee.
currencystringrequirednextChargeAtstring<date-time> | nullrequiredcyclesChargedintegerrequiredcancelAtPeriodEndbooleanrequiredcancelAtstring<date-time>cancelReasonstringbusinessnetworkplatformdeclineReasonstringdeclinedno_responsepausedBystringbusinessplatformReceived. Any 2xx stops retries.