Subscription data model
View field support, webhooks, and list parameters for each integration on the Supported Integrations page.
| Field | Type | Required | Description |
|---|---|---|---|
id | string | No | |
created_at | string (date-time) | No | (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
updated_at | string (date-time) | No | (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
description | string | No | |
contact_id | string | No | a reference to an Accounting Contact (reference to AccountingContact) |
invoice_id | string | No | a reference to an Accounting Invoice (reference to AccountingInvoice) |
current_period_end_at | string (date-time) | No | (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
current_period_start_at | string (date-time) | No | (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
canceled_at | string (date-time) | No | (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
currency | string | No | |
total_amount | number | No | |
start_at | string (date-time) | No | (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
end_at | string (date-time) | No | (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
status | enum | No | Values: ACTIVE, INACTIVE, CANCELED, PAUSED |
month | number | No | the month on which to charge a customer (1-12). Only applies when the interval_unit is YEAR. |
interval_unit | enum | No | Values: YEAR, MONTH, WEEK, DAY |
day_of_month | number | No | 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_week | number | No | 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. |
interval | number | No | The number of intervals between charges within the interval_unit. Defaults to 1. |
lineitems | PaymentLineitem[] | No | |
lineitems[].id | string | No | |
lineitems[].created_at | string (date-time) | No | (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
lineitems[].updated_at | string (date-time) | No | (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
lineitems[].refunded_at | string (date-time) | No | (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
lineitems[].total_amount | number | No | |
lineitems[].refund_amount | number | No | new field |
lineitems[].discount_amount | number | No | |
lineitems[].tax_amount | number | No | |
lineitems[].item_id | string | No | (reference to CommerceItem) |
lineitems[].unit_amount | number | No | |
lineitems[].unit_quantity | number | No | |
lineitems[].item_sku | string | No | |
lineitems[].item_name | string | No | |
lineitems[].item_description | string | No | |
lineitems[].notes | string | No | |
lineitems[].taxrate_id | string | No | |
lineitems[].account_id | string | No | (reference to AccountingAccount) |
metadata | PaymentMetadata[] | No | |
metadata[].id | string | No | |
metadata[].slug | string | No | |
metadata[].value | object | No | |
metadata[].namespace | string | No | |
metadata[].format | enum | No | Values: TEXT, NUMBER, DATE, BOOLEAN, FILE, TEXTAREA, SINGLE_SELECT, MULTIPLE_SELECT, MEASUREMENT, PRICE, YES_NO, CURRENCY, URL |
metadata[].extra_data | object | No |
Are we missing anything? Let us know
Was this page helpful?