GET
/
billing-schedules
/
{billingScheduleId}

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

Path Parameters

billingScheduleId
string
required

Billing Schedule ID

Response

200 - application/json
id
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

endDate
string

End date

taxRates
object[]

Tax Rate for each Product

firstBillingDate
string

First billing date

autoIssueInvoices
boolean
required

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

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

prices
object[]
required

Prices

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.

lastInvoiceId
string

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

timeTravellerId
string

Time traveller ID

phases
object[]
required

Phases

archivedAt
string

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

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