Subscription renewal reminder, 7 days before renewal
Webhook

Request

Sends a reminder when an active order that contains subscription items is 7 days from renewal. The reminder is sent only when the recurring interval of the order is 14 days or more. The reminder is not sent for a paused order, or for the renewal at the end of a trial. The reminder is sent once for that renewal, and remains available until 1 day before the order renews. For more information, see Subscription renewal reminders.

Security
SecretApiKey or JWT
Bodyapplication/json
Payload of the subscription renewal reminder webhook event.
subscriptionIdstring
ID of the order.
Example:"sub_01HRF27SATGE4Z6PBJE6PD8328"
renewalTimestring, (date-time)
Date and time when the subscription renews.
eventTypestring
Type of event that triggered the webhook.
Enum:"subscription-renewal-reminder-30-days""subscription-renewal-reminder-7-days""subscription-renewal-reminder-1-day"
_embeddedobject
Embedded objects related to the order event.
POST
subscription-renewal-reminder-7-days
Payload
{ "subscriptionId": "sub_01HRF27SATGE4Z6PBJE6PD8328", "renewalTime": "2019-08-24T14:15:22Z", "eventType": "subscription-renewal-reminder-30-days", "_embedded": { "subscription": { … } }, "_links": [ { … } ] }

Responses

Returns any 2xx status to indicate that data is received.