Create Billing Schedule

API Reference

Latest Live API

Account
Billing
Collections
Customer
Invoices
Notifications
Product
Taxes
Usage

Version 2024-07-30

Account
Billing
- Prices
- Discounts
- Credits
- Billing Schedules
Collections
Customer
Invoices
Notifications
Product
Taxes
Usage

POST

billing-schedules

Headers

Authorization

string

required

Your API credentials. Eg. Basic {credentials}.

Sequence-Version

enum<string>

Use this header to select an API version

Available options:

2024-07-30

Body

application/json

customerId

string

required

Customer ID

startDate

string

required

Start date

taxRates

object[]

required

Tax Rate for each Product

autoIssueInvoices

boolean

required

Auto-issue invoices for this billing schedule

isDraft

boolean

required

Create in draft status

rollUpBilling

boolean

required

Toggles Roll-up billing

phases

object[]

required

Phases

endDate

string

End date. A null end date denotes an open-ended schedule.

recurrenceDayOfMonth

integer

Recurrence day of month

purchaseOrderNumber

string

Optional purchase order number to be added to invoices

paymentProvider

enum<string>

Payment provider to set up collection for

Available options:

STRIPE,

NONE

attachmentAssetIds

string[]

IDs of assets that are attached to this schedule

autoCharge

boolean

Automatically collect payments if payment details are available

Response

201 - application/json

string

required

Billing Schedule ID

customerId

string

required

Customer ID

status

enum<string>

required

Billing schedule status

Available options:

DRAFT,

PENDING,

ACTIVE,

SUSPENDED,

CANCELLED,

COMPLETED

startDate

string

required

Start date

autoIssueInvoices

boolean

required

If true, invoices will be automatically sent for this billing schedule

prices

object[]

required

Prices

prices.id

string

required

Unique Price ID, generated by Sequence on creation.

prices.productId

string

required

The ID of the Product that this Price is associated with.

prices.name

string

required

A short form description of the price, which appears as the title of line items on invoices.

prices.currency

enum<string>

required

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.

Available options:

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

prices.structure

object

required

The pricing structure for this price. This can be a simple fixed price, or a more complex structure that varies based on usage.

prices.billingFrequency

enum<string>

required

The frequency with which this price is billed.

Available options:

ON_DEMAND,

ONE_TIME,

MONTHLY,

QUARTERLY,

YEARLY

prices.billingType

enum<string>

required

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).

Available options:

IN_ARREARS,

IN_ADVANCE

prices.createdAt

string

required

Time at which the Price was initially created, in ISO 8601 format.

prices.updatedAt

string

Time at which the Price was last updated, in ISO 8601 format.

prices.integrationIds

object[]

required

Alternate IDs for this Price in third-party integration systems

prices.customMetricParameters

object[]

required

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.

prices.listPriceId

string

The list price ID, if this price variant was created from a list price

prices.usageCalculationPeriod

object

The period over which usage is aggregated.

createdAt

string

required

Time at which the schedule was initially created, in ISO 8601 format.

updatedAt

string

required

Time at which the schedule was last updated, in ISO 8601 format.

phases

object[]

required

Phases

rollUpBilling

boolean

required

Roll up billing

integrationIds

object[]

required

External services which are linked to this customer

attachmentAssets

object[]

required

Assets attached to this billing schedule

endDate

string

End date

taxRates

object[]

Tax Rate for each Product

firstBillingDate

string

First billing date

purchaseOrderNumber

string

Optional purchase order number to be added to invoices

reference

string

Optional reference to be added to invoices

label

string

Optional label

recurrenceDayOfMonth

integer

The day of the month on which billing recurs

lastInvoiceId

string

ID of the last invoice (if there has been one)

archivedAt

string

Time at which the schedule was archived, in ISO 8601 format.

List all Billing Schedules Get Billing Schedule