Subscription data model
View field support, webhooks, and list parameters for each integration on the Supported Integrations page.
idstring
created_atdate
(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
updated_atdate
(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
descriptionstring
contact_idstring
a reference to an Accounting Contact (reference to AccountingContact)
invoice_idstring
a reference to an Accounting Invoice (reference to AccountingInvoice)
current_period_end_atdate
(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
current_period_start_atdate
(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
canceled_atdate
(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
currencystring
start_atdate
(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
end_atdate
(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
status enum
Valid values:
"ACTIVE"
"INACTIVE"
"CANCELED"
"PAUSED"
monthnumber
the month on which to charge a customer (1-12). Only applies when the interval_unit is YEAR.
interval_unit enum
Valid values:
"YEAR"
"MONTH"
"WEEK"
"DAY"
day_of_monthnumber
The day of the month to charge customers on. 1-28 or -1 to indicate the last day of the month. Only applies when the interval_unit is MONTH.
day_of_weeknumber
The day of the week to charge customers on. 1-7 or -1 to indicate the last day of the week. Only applies when the interval_unit is WEEK.
intervalnumber
The number of intervals between charges within the interval_unit. Defaults to 1.
Are we missing anything? Let us know