> ## Documentation Index
> Fetch the complete documentation index at: https://docs.sequencehq.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Data models

> Export any of these data tables to your preferred destination

### 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 |


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.