Payment card expiration reminder, 7 days before expiration
Webhook

Request

Sends a reminder when the active default payment card of a customer is 7 days from expiring. The reminder is sent only when the customer has an order that contains subscription items, and that order has started and is not churned. The reminder is sent once for that expiration, and remains available until 1 day before the card expires. For more information, see Payment card expiration reminders.

Security
SecretApiKey or JWT
Bodyapplication/json
Payload of the payment card expiration reminder webhook event.
paymentCardIdstring
ID of the payment card.
eventTypestring
Type of event that triggered the webhook.
Enum:"payment-card-expiration-reminder-14-days""payment-card-expiration-reminder-7-days""payment-card-expiration-reminder-1-day"
_embeddedobject
Embedded objects related to the payment card event.
_linksArray of objects
Links to related resources.
POST
payment-card-expiration-reminder-7-days
Payload
{
  "paymentCardId": "string",
  "eventType": "payment-card-expiration-reminder-14-days",
  "_embedded": {
    "paymentCard": { … }
  },
  "_links": [
    { … }
  ]
}

Responses

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