Billing Schedules
Get Billing Schedule
Retrieve the details of one of your Billing Schedules.
GET
/
billing-schedules
/
{billingScheduleId}
Headers
Authorization
string
requiredYour API credentials. Eg. Basic {credentials}
.
Sequence-Version
enum<string>
Use this header to select an API version
Available options:
2024-05-09
Path Parameters
billingScheduleId
string
requiredBilling Schedule ID
Response
200 - application/json
id
string
requiredBilling Schedule ID
sequenceAccountId
string
requiredSequence Account ID
customerId
string
requiredCustomer ID
status
enum<string>
requiredStatus
Available options:
DRAFT
, PENDING
, ACTIVE
, SUSPENDED
, CANCELLED
, COMPLETED
startDate
string
requiredStart date
endDate
string
End date
taxRates
object[]
Tax Rate for each Product
firstBillingDate
string
First billing date
autoIssueInvoices
boolean
requiredAuto-issue invoices 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
Recurrence day of month
priceIds
any[]
requiredPrice IDs
prices
any[]
requiredPrices
type
enum<string>
requiredBilling schedule type
Available options:
CUSTOM
, PLAN
, PHASES
createdAt
string
requiredCreated at
updatedAt
string
requiredLast updated at
lastInvoiceId
string
ID of the last invoice (if there has been one)
timeTravellerId
string
Time traveller ID
phases
object[]
requiredPhases
archivedAt
string
Archived at
rollUpBilling
boolean
requiredRoll up billing
integrationIds
object[]
requiredExternal services which are linked to this customer
attachmentAssets
object[]
requiredAssets attached to this billing schedule