Skip to main content
WEBHOOK
invoice
{
  "id": "<string>",
  "type": "invoice.void",
  "object": "event",
  "created": "2023-11-07T05:31:56Z",
  "data": {
    "invoiceId": "<string>",
    "subscriptionId": "<string>",
    "orderId": "<string>",
    "customerId": "<string>",
    "merchantId": "<string>",
    "status": "open",
    "createTime": 1754819712625,
    "currentPeriodStart": 1754819706689,
    "currentPeriodEnd": 1755078906689,
    "originalAmount": 9.99,
    "originalCurrency": "USD",
    "billing": "charge_automatically",
    "items": [
      {
        "invoiceItemId": "<string>",
        "amount": 9.99,
        "currency": "USD",
        "description": "<string>",
        "periodStart": 1754819706689,
        "periodEnd": 1755078906689,
        "proration": true,
        "price": {
          "productId": "<string>",
          "productName": "<string>",
          "priceId": "<string>",
          "priceSnapshotId": "<string>",
          "unitAmount": 9.99,
          "quantity": 1,
          "recurring": {
            "interval": "week",
            "trialPeriodDays": 123,
            "pricingModel": "flat_rate",
            "tiersMode": "volume"
          }
        }
      }
    ]
  }
}

Body

application/json

Invoice event payload in json

​
id
string

Unique identifier for the event

​
type
enum<string>

Type of event that occurred

Available options:
invoice.open,
invoice.paid,
invoice.void
Example:

"invoice.void"

​
object
string

Type of this json payload, 'event' if this is an event

Example:

"event"

​
created
string<date-time>

Timestamp when the event occurred

​
data
object

Comprehensive invoice data object with subscription billing details

Response

200

Return a 200 status to indicate that the data was received successfully