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
autoIssueInvoices
boolean
required

Auto-issue invoices for this billing schedule

customerId
string
required

Customer ID

isDraft
boolean
required

Create in draft status

phases
object[]
required

Phases

rollUpBilling
boolean
required

Toggles Roll-up billing

startDate
string
required

Start date

taxRates
object[]
required

Tax Rate for each Product

attachmentAssetIds
string[]

IDs of assets that are attached to this schedule

autoCharge
boolean

Automatically collect payments if payment details are available

endDate
string

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

paymentProvider
enum<string>

Payment provider to set up collection for

Available options:
STRIPE,
NONE
purchaseOrderNumber
string

Optional purchase order number to be added to invoices

recurrenceDayOfMonth
integer

Recurrence day of month

Response

201 - application/json
attachmentAssets
object[]
required

Assets attached to this billing schedule

autoIssueInvoices
boolean
required

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

createdAt
string
required

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

customerId
string
required

Customer ID

id
string
required

Billing Schedule ID

integrationIds
object[]
required

External services which are linked to this customer

phases
object[]
required

Phases

prices
object[]
required

Prices

rollUpBilling
boolean
required

Roll up billing

startDate
string
required

Start date

status
enum<string>
required

Billing schedule status

Available options:
DRAFT,
PENDING,
ACTIVE,
SUSPENDED,
CANCELLED,
COMPLETED
updatedAt
string
required

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

archivedAt
string

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

endDate
string

End date

firstBillingDate
string

First billing date

label
string

Optional label

lastInvoiceId
string

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

purchaseOrderNumber
string

Optional purchase order number to be added to invoices

recurrenceDayOfMonth
integer

The day of the month on which billing recurs

reference
string

Optional reference to be added to invoices

taxRates
object[]

Tax Rate for each Product