Skip to main content
WEBHOOK
subscription
{
  "id": "<string>",
  "type": "subscription.activated",
  "object": "event",
  "created": "2023-11-07T05:31:56Z",
  "data": {
    "merchantReference": "<string>",
    "subscriptionId": "<string>",
    "customerId": "<string>",
    "productId": "<string>",
    "priceId": "<string>",
    "priceSnapshotId": "<string>",
    "createTime": 1754819711382,
    "quantity": 1,
    "paymentMethodType": "CARD",
    "paymentInstrumentId": "<string>",
    "trialStart": 1754819707000,
    "trialEnd": 1755078907000,
    "currentPeriodStart": 1754819706689,
    "currentPeriodEnd": 1755078906689,
    "cancelAt": 123,
    "cancelAtPeriodEnd": true,
    "canceledAt": 123,
    "cancelReason": "<string>",
    "status": "incomplete",
    "billing": "charge_automatically",
    "currency": "USD",
    "recurringInvoiceItem": {
      "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"
        }
      }
    },
    "upcomingInvoiceItem": {
      "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

Subscription event payload in json

​
id
string

Unique identifier for the event

​
type
enum<string>

Type of event that occurred

Available options:
subscription.created,
subscription.trialing,
subscription.activated,
subscription.incomplete_expired,
subscription.past_due,
subscription.cancelled
Example:

"subscription.activated"

​
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

Subscription data object containing all subscription details

Response

200

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