Skip to main content

SubscriptionItemEventPayload

item objectrequired
createdAtstringnullable
descriptionstringnullable
idstringrequired
metadata objectrequired
property name*string
priceIdstringrequired
productIdstringrequired
productNamestringnullable
quantityinteger<int32>required
subscriptionIdstringrequired
unitAmountinteger<int64>required
organizationIdstringrequired
proration objectrequired
currentPeriodEndstringrequired
currentPeriodStartstringrequired
daysInCycleinteger<int32>required
daysRemaininginteger<int32>required
itemIdstringnullable
priceIdstringnullable
productIdstringnullable
prorationAmountinteger<int64>required
quantityDeltainteger<int32>required
resultingQuantityinteger<int32>nullable
unitAmountinteger<int64>required
prorationChargeMessagestringnullable
prorationChargeStatusstringrequired
subscriptionAmountinteger<int64>required
SubscriptionItemEventPayload
{
  "item": {
    "createdAt": "string",
    "description": "string",
    "id": "string",
    "metadata": {},
    "priceId": "string",
    "productId": "string",
    "productName": "string",
    "quantity": 0,
    "subscriptionId": "string",
    "unitAmount": 0
  },
  "organizationId": "string",
  "proration": {
    "currentPeriodEnd": "string",
    "currentPeriodStart": "string",
    "daysInCycle": 0,
    "daysRemaining": 0,
    "itemId": "string",
    "priceId": "string",
    "productId": "string",
    "prorationAmount": 0,
    "quantityDelta": 0,
    "resultingQuantity": 0,
    "unitAmount": 0
  },
  "prorationChargeMessage": "string",
  "prorationChargeStatus": "string",
  "subscriptionAmount": 0
}