Back to Webhook

Subscription Model


ATTRIBUTES
  • Amount decimal
    Amount paid per billing interval.
  • BillingPeriodEndDate string
    End time and date for the current billing period, in format MM/dd/yyyy HH:mm:ss.fff.
  • BillingPeriodStartDate string
    Start time and date for the current billing period, in format MM/dd/yyyy HH:mm:ss.fff.
  • CancelledDate string
    Time and date when the subscription was cancelled. If the subscription has been cancelled this field will be filled, otherwise this field will be null.
  • Conversion ConversionModel
    The conversion object for this subscription.
  • CreatedDate string
    Time and date when the subscription was created, in format MM/dd/yyyy HH:mm:ss.fff.
  • Currency string
    A three character string describing the currency for the company i.e gbp.
  • Demo bool
    Flag describes if the flow is currently running on demo or live mode.
  • Id integer
    A unique identifier for this subscription.
  • Interval string
    The frequency with which a subscription should be billed. Can be: day, week, month or year.
  • IntervalCount integer
    The number of intervals between billings. For example, if interval was month and count was 3 then billing would occur every 3 months.
  • PlanID string
    A unique identifier for the plan this subscription occurred on.
  • Status string
    The current status of this subscription. Will return 'active' if the subscription is active and 'payment_received' when we have a confirmed that the subscription invoice was paid.
Example Response