{
  "eventId": "67543b151a8e457dcf93242",
  "eventType": "subscription.unpaid",
  "eventTime": 1729608043615,
  "subscriptionId": "67543b151a8e8b7dcf93234",
  "nextPaymentDate": null,
  "remainingCycleCount": ,
  "metadata": { 
    "orderId": "12345",
    "customerNote": "Deliver after 5 PM" 
  } 
}

{
  "eventId": "67543b151a8e457dcf93242",
  "eventType": "subscription.unpaid",
  "eventTime": 1729608043615,
  "subscriptionId": "67543b151a8e8b7dcf93234",
  "nextPaymentDate": null,
  "remainingCycleCount": ,
  "metadata": { 
    "orderId": "12345",
    "customerNote": "Deliver after 5 PM" 
  } 
}
​
eventId
string

A unique identifier for this specific event. This ensures that each event can be tracked and processed individually.

​
eventType
string

Describes the type of event. In this case, it signifies that a subscription has transitioned to an unpaid state.

​
eventTime
integer

The timestamp when the event was generated, typically in milliseconds since the Unix epoch (January 1, 1970). This value can be used to track when the event occurred.

​
subscriptionId
string

A unique identifier for the specific subscription that has become inactive.

​
nextPaymentDate
integer

The next payment date for the subscription. This will typically be null when the subscription becomes inactive.

​
remainingCycleCount
integer

The number of billing cycles remaining for the subscription. For an inactive subscription, this will generally be 0.

​
metadata
object

A collection of key-value pairs that were provided when the object was created. These metadata values are echoed back in the response, allowing you to store and retrieve custom information such as context-specific attributes, references, or tags. This can be useful for correlating records in your system or attaching meaningful context to transactions.

Was this page helpful?