Latest Live API
- Account
- Billing
- Collections
- Customer
- Invoices
- Notifications
- Product
- Taxes
- Usage
Version 2024-07-30
- Account
- Billing
- Collections
- Customer
- Invoices
- Notifications
- Product
- Taxes
- Usage
List all Billing Schedules
List all Billing Schedules.
Your API credentials. Eg. Basic {credentials}.
Use this header to select an API version
Filter by customer ID.
Filter by status.
Filter by auto send invoices.
Filter by label.
Include archived schedules.
Sort column. Default: creation time.
Pagination cursor. To page through items, omit this parameter to retrieve the first page, and then successively use the value you get from pagination.after or pagination.before to retrieve each page.
Pagination cursor. To page through items, omit this parameter to retrieve the first page, and then successively use the value you get from pagination.after or pagination.before to retrieve each page.
Maximum number of objects to return per-page. Must be between 1 and 100 (inclusive).
Sort order. Default: DESC (descending, most often used for reverse chronological sorting).
Headers
Your API credentials. Eg. Basic {credentials}.
Use this header to select an API version
2024-07-30 Query Parameters
Filter by customer ID.
Filter by status.
Filter by auto send invoices.
Filter by label.
Include archived schedules.
Sort column. Default: creation time.
START_DATE Pagination cursor. To page through items, omit this parameter to retrieve the first page, and then successively use the value you get from pagination.after or pagination.before to retrieve each page.
Pagination cursor. To page through items, omit this parameter to retrieve the first page, and then successively use the value you get from pagination.after or pagination.before to retrieve each page.
Maximum number of objects to return per-page. Must be between 1 and 100 (inclusive).
Sort order. Default: DESC (descending, most often used for reverse chronological sorting).
Response
Billing Schedules
Billing Schedule ID
Customer ID
Billing schedule status
DRAFT, PENDING, ACTIVE, SUSPENDED, CANCELLED, COMPLETED Start date
End date
First billing date
If true, invoices will be automatically sent for this billing schedule
Optional purchase order number to be added to invoices
Optional reference to be added to invoices
Optional label
The day of the month on which billing recurs
Prices
Unique Price ID, generated by Sequence on creation.
The ID of the Product that this Price is associated with.
A short form description of the price, which appears as the title of line items on invoices.
The currency in which this price is denominated. This must be a valid ISO 4217 currency code, that is currently part of currencies supported by Sequence.
ARS, AUD, BRL, CAD, CHF, CNY, COP, CZK, DKK, EUR, GBP, HKD, ILS, JPY, KRW, MXN, NOK, NZD, PLN, SEK, SGD, THB, USD, UYU, ZAR The pricing structure for this price. This can be a simple fixed price, or a more complex structure that varies based on usage.
A list of contiguous pricing tiers
The upper bound of usage for this tier. Set to null to if this is a final tier and is unbounded. The lower bound is set by the previous tier or 0 if it's the first one.
The rate to apply to usage for this product in this tier. In the case of percentage pricing where isPricePercentage is set to true, a value of 1 represents 100%.
The nominal fee associated with usage at this tier
Indicate whether the price attribute is to be considered as a percentage or an absolute value.
The usage metric associated to this pricing structure
Indicates the scope of usage calculation
BILLING_PERIOD, CUMULATIVE, PERIODIC The type of pricing
GRADUATED The frequency with which this price is billed.
ON_DEMAND, ONE_TIME, MONTHLY, QUARTERLY, YEARLY Indicate at which point of the billing period to generate the invoice for this price. This can be either in-arrears (after the period ends), or in-advnace (at the beginning of the period).
IN_ARREARS, IN_ADVANCE Time at which the Price was initially created, in ISO 8601 format.
Time at which the Price was last updated, in ISO 8601 format.
Alternate IDs for this Price in third-party integration systems
Amazon_Redshift, Google_BigQuery, Google_Sheets, HubSpot, NetSuite, QuickBooks_Online, Salesforce, Slack, Snowflake, Stripe, Xero, Avalara, Anrok Specific parameters to influence usage calculation for this Price, and are only required when using custom metric. Please speak to your Sequence contacts for further information prior to usage.
The list price ID, if this price variant was created from a list price
The period over which usage is aggregated.
Frequency determines the time period over which usage is aggregated.
MONTHLY, QUARTERLY, YEARLY Interval determines the time period over which usage is aggregated. For example, if the frequency is MONTHLY and the interval is 3, the usage is aggregated over 3 months before starting at 0 again.
Time at which the schedule was initially created, in ISO 8601 format.
Time at which the schedule was last updated, in ISO 8601 format.
ID of the last invoice (if there has been one)
Phases
Phase ID
Created at
Billing Schedule ID
Price IDs
Start Date
End date
Discounts in Phase
Price IDs to which this discount applies
Whether the discount is a nominal or percentage amount
PERCENTAGE, NOMINAL The discount amount
The message to show on an invoice
If true the discount will show as a separate line item on an invoice
Minimum ID
Sequence Account ID
Billing Schedule ID
Phase ID
Minimum amount
Price IDs the minimum is restricted to
Created at
Updated at
Time at which the schedule was archived, in ISO 8601 format.
Roll up billing
External services which are linked to this customer
Amazon_Redshift, Google_BigQuery, Google_Sheets, HubSpot, NetSuite, QuickBooks_Online, Salesforce, Slack, Snowflake, Stripe, Xero, Avalara, Anrok Assets attached to this billing schedule
Unique ID
The Sequence user who created this asset
Either image or document
IMAGE, DOCUMENT Identifies the intended data format. Allowed formats are: jpg, jpeg, png, and pdf
JPEG, PNG, PDF Filename of the uploaded file
Size of the uploaded file in bytes
URL to download the asset
Creation timestamp. Formatted as an ISO 8601 timestamp.