Schedule
Create Billing Schedule
Schedule
Create Billing Schedule
Create a new Billing Schedule within one of your Sequence Accounts.
POST
/
billing-schedules
Header
Body
curl --request POST \
--url https://eu.sequencehq.com/api/billing-schedules \
--header 'Authorization: <authorization>' \
--header 'Content-Type: application/json'{
"autoIssueInvoices": "boolean",
"createdAt": "2022-06-28T16:47:00Z",
"customerId": "cca32597-b6b0-4499-9669-128aef8702e4",
"endDate": "2022-12-01T12:00:00Z",
"firstBillingDate": "2022-02-02T22:30:00Z",
"id": "b102e007-f5d7-4b1a-8a1d-9a51135ae73b",
"lastInvoiceId": "bdbf78a5-b007-4d46-aa7d-d0417a649d64",
"planId": "6dc54805-0ac8-4f17-9341-4d3f2db9dcd8",
"priceIds": [],
"purchaseOrderNumber": "PO123",
"recurrenceDayOfMonth": "1",
"sequenceAccountId": "c4602d51-0fb4-4b48-b689-6ba28f540d1e",
"startDate": "2022-01-01T12:00:00Z",
"status": "ACTIVE",
"taxRates": [
{
"priceId": "bc61d4b8-e9d6-4f4a-9bcf-f5dae874c730",
"taxRateId": "50c0d53b-8460-41e6-b4e9-a4e157fc1a64"
}
],
"timeTravellerId": "43f3dad8-23b0-4141-8813-4260b86a7ebb",
"type": "CUSTOM"
}Headers
Authorizationrequired
string
Your API credentials. Eg. Basic {credentials}.
Idempotency-Key
string
Specifying a unique ID for this request here lets you retry it without risk of performing the same operation twice.
Body
application/json
Option 1
Option 2
autoIssueInvoicesrequired
boolean
collectionPaymentProvider
enum<string>
Available options:
STRIPE, UNRECOGNIZED createAsDraftrequired
boolean
customerIdrequired
string
discounts
object[]
endDaterequired
string
planIdrequired
string
purchaseOrderNumber
string
recurrenceDayOfMonth
integer
startDaterequired
string
taxRates
object[]
priceIds
string[]
Response
201 - application/json
Option 1
Option 2
autoIssueInvoicesrequired
boolean
createdAt
string
customerIdrequired
string
endDate
string
firstBillingDate
string
idrequired
string
lastInvoiceId
string
planIdrequired
string
purchaseOrderNumber
string
recurrenceDayOfMonth
integer
sequenceAccountIdrequired
string
startDaterequired
string
statusrequired
enum<string>
Available options:
DRAFT, PENDING, ACTIVE, SUSPENDED, CANCELLED, COMPLETED taxRates
object[]
timeTravellerId
string
typerequired
enum<string>
Available options:
CUSTOM, PLAN priceIds
any[]
curl --request POST \
--url https://eu.sequencehq.com/api/billing-schedules \
--header 'Authorization: <authorization>' \
--header 'Content-Type: application/json'{
"autoIssueInvoices": "boolean",
"createdAt": "2022-06-28T16:47:00Z",
"customerId": "cca32597-b6b0-4499-9669-128aef8702e4",
"endDate": "2022-12-01T12:00:00Z",
"firstBillingDate": "2022-02-02T22:30:00Z",
"id": "b102e007-f5d7-4b1a-8a1d-9a51135ae73b",
"lastInvoiceId": "bdbf78a5-b007-4d46-aa7d-d0417a649d64",
"planId": "6dc54805-0ac8-4f17-9341-4d3f2db9dcd8",
"priceIds": [],
"purchaseOrderNumber": "PO123",
"recurrenceDayOfMonth": "1",
"sequenceAccountId": "c4602d51-0fb4-4b48-b689-6ba28f540d1e",
"startDate": "2022-01-01T12:00:00Z",
"status": "ACTIVE",
"taxRates": [
{
"priceId": "bc61d4b8-e9d6-4f4a-9bcf-f5dae874c730",
"taxRateId": "50c0d53b-8460-41e6-b4e9-a4e157fc1a64"
}
],
"timeTravellerId": "43f3dad8-23b0-4141-8813-4260b86a7ebb",
"type": "CUSTOM"
}