Data models - Sequence

Billing Schedule Phase Prices

One record per (billing schedule, phase, price) combination

Field	Description	Data Type
id	Unique ID of the (billing schedule, phase, price) combination	STRING
billing_schedule_id	Billing schedule ID	STRING
customer_id	Customer ID	STRING
customer_legal_name	Customer legal name	STRING
billing_schedule_start_date	Billing schedule start date	DATE
billing_schedule_end_date	Null for unbounded billing schedules	DATE
billing_schedule_archived_at	Timestamp at which the billing schedule was archived	TIMESTAMP
currency	Currency	STRING
phase_id	Billing schedule phase ID	STRING
phase_start_date	Billing schedule phase start date	DATE
phase_end_date	Billing schedule phase end date	DATE
phase_archived_at	Billing schedule phase archived at date	TIMESTAMP
phase_global_discount_amount	Discount amount globally applied to all prices in the phase	DECIMAL
phase_global_discount_calculation_type	Percentage or nominal	STRING
phase_global_usage_minimum_amount	Minimum commitment across all usage-based prices in the phase	DECIMAL
price_id	Price ID	STRING
arr_calculation	ARR calculation (optional)	STRING
product_id	Product ID	STRING
price_name	Price name	STRING
price_structure	Price configuration, e.g. unit charge, tiers	JSON
price_billing_frequency	Monthly, quarterly, annually or one-time	STRING
price_billing_type	In advance or in arrears	STRING
price_discount_amount	Discount amount applied to the price	DECIMAL
price_discount_calculation_type	Percentage or nominal	STRING
price_minimum_amount	Minimum commitment applied to the price	DECIMAL
modified_at	Last modified timestamp for this record	TIMESTAMP
status	Billing schedule status	STRING

Customers

One record per customer

Field	Description	Data Type
id	Customer ID	STRING
label	Customer human-readable label	STRING
customer_aliases	Comma-separated list of customer aliases, used in usage and seat events	STRING
contact_name	Contact name	STRING
legal_name	Legal name	STRING
address_line1	Address first line	STRING
address_line2	Address second line	STRING
address_town	Address town	STRING
address_post_code	Address post code	STRING
address_country	Address country	STRING
address_state	Address state	STRING
email	Primary billing email address	STRING
billing_emails	Comma-separated list of secondary billing emails	STRING
telephone	Telephone number	STRING
url	Website URL	STRING
parent_id	ID of the parent customer, populated from customer organization ownership	STRING
integration_ids	JSON array of integration IDs linking this customer to external services (e.g. Stripe, Xero, Salesforce)	JSON
created_at	Timestamp at which the customer was created	TIMESTAMP
archived_at	Timestamp at which the customer was archived	TIMESTAMP
modified_at	Last modified timestamp for this record	TIMESTAMP

Invoices

One record per invoice

Field	Description	Data Type
id	Invoice ID	STRING
customer_id	Customer ID	STRING
customer_legal_name	Customer legal name	STRING
invoice_number	Invoice number	STRING
issue_date	Issue date	DATE
due_date	Due date	DATE
purchase_order_number	Purchase order number	STRING
memo	Memo	STRING
status	Sent, final, voided, draft or in progress	STRING
payment_status	Paid, partially paid, unpaid or uncollectible	STRING
net_total	Net total	DECIMAL
gross_total	Gross total	DECIMAL
total_tax	Total tax	DECIMAL
currency	Currency	STRING
billing_schedule_id	ID of the billing schedule that generated the invoice	STRING
billing_period_start	Start timestamp of the billing period for the invoice	TIMESTAMP
billing_period_end	End timestamp of the billing period for the invoice	TIMESTAMP
calculated_at	Latest timestamp at which the invoice was calculated	TIMESTAMP
deleted_at	Timestamp at which the invoice was deleted	TIMESTAMP
modified_at	Last modified timestamp for this record	TIMESTAMP

Invoice Line Items

One record per invoice line item

Field	Description	Data Type
id	Line item ID	STRING
invoice_id	Invoice ID	STRING
title	Line item title	STRING
description	Line item description	STRING
quantity	Number of units	DECIMAL
rate	Unit fee	DECIMAL
product_id	ID of the product associated with this line item	STRING
price_id	ID of the price that generated this line item	STRING
tax_rate	Tax rate	DECIMAL
service_period_start_date	Service period start date	DATE
service_period_end_date	Service period end date	DATE
billing_schedule_id	ID of the billing schedule that generated the invoice	STRING
deleted_at	Timestamp at which the line item was deleted	TIMESTAMP
billing_period_start	Start timestamp of the billing period for the invoice	TIMESTAMP
billing_period_end	End timestamp of the billing period for the invoice	TIMESTAMP
currency	Currency	STRING
net_total	Net total	DECIMAL
gross_total	Gross total	DECIMAL
total_tax	Total tax	DECIMAL
calculated_at	Latest timestamp at which the invoice was calculated	TIMESTAMP
modified_at	Last modified timestamp for this record	TIMESTAMP

Credit Notes

One record per credit note

Field	Description	Data Type
id	Credit Note ID	STRING
customer_id	Customer ID	STRING
customer_legal_name	Customer legal name	STRING
invoice_id	ID of the invoice that generated the credit note	STRING
credit_note_number	Credit note number	STRING
issue_date	Issue date	DATE
purchase_order_number	Purchase order number	STRING
memo	Memo	STRING
status	Sent, final, voided, draft or in progress	STRING
net_total	Net total	DECIMAL
gross_total	Gross total	DECIMAL
total_tax	Total tax	DECIMAL
currency	Currency	STRING
billing_schedule_id	ID of the billing schedule that generated the credit note	STRING
billing_period_start	Start timestamp of the billing period for the invoice	TIMESTAMP
billing_period_end	End timestamp of the billing period for the invoice	TIMESTAMP
modified_at	Last modified timestamp for this record	TIMESTAMP

Credit Note Line Items

One record per credit note line item

Field	Description	Data Type
id	Line item ID	STRING
credit_note_id	Credit Note ID	STRING
title	Line item title	STRING
description	Line item description	STRING
quantity	Number of units	DECIMAL
rate	Unit fee	DECIMAL
price_id	ID of the price that generated this line item	STRING
tax_rate	Tax rate	DECIMAL
billing_schedule_id	ID of the billing schedule that generated the credit note	STRING
billing_period_start	Start timestamp of the billing period for the invoice	TIMESTAMP
billing_period_end	End timestamp of the billing period for the invoice	TIMESTAMP
currency	Currency	STRING
net_total	Net total	DECIMAL
gross_total	Gross total	DECIMAL
total_tax	Total tax	DECIMAL
modified_at	Last modified timestamp for this record	TIMESTAMP

Prices

One record per price

Field	Description	Data Type
id	Price ID	STRING
product_id	Product ID	STRING
product_name	Product name	STRING
currency	Currency	STRING
billing_type	In advance or in arrears	STRING
billing_frequency	Monthly, quarterly, annually or one-time	STRING
structure	Price configuration, e.g. unit charge, tiers	JSON
modified_at	Last modified timestamp for this record	TIMESTAMP

Seat Events

One record per seat event

Field	Description	Data Type
id	Seat event ID	STRING
customer_event_id	User-provided ID for the seat event	STRING
customer_alias	Customer alias or ID	STRING
customer_id	Customer ID	STRING
customer_legal_name	Customer legal name	STRING
seat_type	Seat type	STRING
seat_metric_label	Human-readable label for the metric tracking this event	STRING
seat_metric_description	Description for the metric tracking this event	STRING
seat_metric_value	Current value of the metric tracking this event	INTEGER
is_latest	Whether this event is the latest for this customer and seat type	BOOLEAN
modified_at	Last modified timestamp for this record	TIMESTAMP
event_timestamp	User-provided timestamp for this seat event	TIMESTAMP

Usage Metrics

One record per usage metric. Each record describes the metric definition and aggregation settings.

Field	Description	Data Type
id	Usage Metric ID	STRING
event_type	Event type	STRING
aggregation_type	Aggregation type	STRING
aggregation_property	Aggregation property	STRING
unit	Unit of measure for the aggregation	STRING
name	Name of the usage metric	STRING
grouping_property	Property used for grouping usage	STRING
property_filters	Property filters	JSON
metric_type	Metric type	STRING
description	Description	STRING
properties_to_negate	Properties to negate	JSON
modified_at	Last modified timestamp for this record	TIMESTAMP

Customer Custom Properties

One record per customer custom property (user-defined key/value pair)

Field	Description	Data Type
id	Custom property ID	STRING
customer_id	Customer ID	STRING
custom_key	User-defined custom property key	STRING
custom_value	User-defined custom property value	STRING
created_at	Timestamp at which the custom property was created	TIMESTAMP
deleted_at	Timestamp at which the custom property was deleted	TIMESTAMP
modified_at	Last modified timestamp for this record	TIMESTAMP

Billing Schedule Custom Fields

One record per billing schedule custom field (user-defined key/value pair)

Field	Description	Data Type
id	Custom field ID	STRING
billing_schedule_id	Billing schedule ID	STRING
custom_key	User-defined custom field key	STRING
custom_value	User-defined custom field value	STRING
created_at	Timestamp at which the custom field was created	TIMESTAMP
deleted_at	Timestamp at which the custom field was deleted	TIMESTAMP
modified_at	Last modified timestamp for this record	TIMESTAMP

​Billing Schedule Phase Prices

​Customers

​Invoices

​Invoice Line Items

​Credit Notes

​Credit Note Line Items

​Prices

​Seat Events

​Usage Metrics

​Customer Custom Properties

​Billing Schedule Custom Fields