Subscription Interval

Subscription Interval is sent periodically based on a subscription's billing cycle, such as monthly or annually. This webhook provides updates on the recurring nature of the subscription, including charges or renewal reminders. It helps businesses maintain transparency, generate invoices, or send reminders for upcoming payments to the customer.

Example of Request Payload Object (subscription_interval)

{
  "id": "04986b95-9406-4fb0-a683-a8703e521e7b",
  "type": "subscription_interval",
  "testMode": true,
  "data": {
    "user": {
      "id": "b38c3b93-4d07-4ad3-9dd8-04b056b339ee",
      "email": "[e-mail]",
      "object": "user",
      "username": null,
      "internalId": null
    },
    "items": [],
    "lastPayment": {
      "id": "55940915-2822-4860-bbf0-1df1375361f1",
      "fee": 0,
      "tax": 0,
      "type": "subscription_initial",
      "value": 0,
      "number": "S3oQQCCw7wOC6VeO",
      "object": "payment",
      "status": "PAID",
      "userId": "b38c3b93-4d07-4ad3-9dd8-04b056b339ee",
      "orderId": "55940915-2822-4860-bbf0-1df1375361f1",
      "currency": "USD",
      "createdAt": 1732373466231,
      "orderNumber": "S3oQQCCw7wOC6VeO",
      "currencyDecimals": 2
    },
    "subscription": {
      "id": "S3oQQCCw7wOC6VeO",
      "object": "subscription",
      "userId": "b38c3b93-4d07-4ad3-9dd8-04b056b339ee",
      "orderId": "55940915-2822-4860-bbf0-1df1375361f1",
      "createdAt": 1731938713000,
      "canceledAt": null,
      "orderNumber": "S3oQQCCw7wOC6VeO",
      "lastPaymentId": "55940915-2822-4860-bbf0-1df1375361f1",
      "lastPaymentNumber": "S3oQQCCw7wOC6VeO",
      "currentIntervalEnd": 1734530713000,
      "cancelAtIntervalEnd": false,
      "currentIntervalStart": 1731938713000
    }
  },
  "idempotencyKey": "04986b95-9406-4fb0-a683-a8703e521e7b"
}