subscription-payment-status-changed

This event is triggered whenever a subscription payment has its status changed.

Payload (object)

• id (string) The payment id
• subscriptionPlanId (string) The subscription plan's id
• subscriptionPlanName (string) The subscription plan's name
• merchantId (string) The merchant id for the subscription
• userId (string) The user for the subscription
• subscriptionId (string) The subscription id
• dueDate (string) When this payment is due
• checkoutInstrumentId (string) The instrument id used to charge this payment
• instrumentType (enum)
  • payment-card-1
• amount (object)
  • value (number) - The amount to be paid in float point
  • currency (string) - 3 letters ISO code for currency
  • formattedValue (string) - The formatted value, e.g: $10.00
  • digits (number) - The amount of decimal places this currency has
  • wholeValue (number)
    An integer value for the least significant value for this currency, eg.: $10.00 would be 1000. It can be thought as how many cents for this operation
• status (enum)
  • PENDING
  • COMPLETED
  • FAILED

{
  id: 'string',
  subscriptionPlanId: 'string',
  subscriptionPlanName: 'string',
  merchantId: 'string',
  userId: 'string',
  subscriptionId: 'string',
  dueDate: 'string',
  checkoutInstrumentId: 'string',
  instrumentType: 'string',
  amount: {
    value: number,
    currency: 'string',
    formattedValue: 'string',
    digits: number,
    wholeValue: number,
  },
  status: 'string',
}