GET
/
billing-schedules
/
{billingScheduleId}
curl --request GET \
  --url https://eu.sequencehq.com/api/billing-schedules/{billingScheduleId} \
  --header 'Authorization: <authorization>'
{
  "id": "b102e007-f5d7-4b1a-8a1d-9a51135ae73b",
  "sequenceAccountId": "c4602d51-0fb4-4b48-b689-6ba28f540d1e",
  "customerId": "cca32597-b6b0-4499-9669-128aef8702e4",
  "status": "ACTIVE",
  "activeVersion": {
    "id": "499f5dde-9735-4f6f-9ca8-337071e562ee",
    "version": 1,
    "validityPeriod": {
      "startDate": "2022-01-01",
      "endDate": "2022-12-01"
    },
    "startDate": "2022-01-01",
    "endDate": "2022-12-01",
    "taxRates": [
      {
        "priceId": "bc61d4b8-e9d6-4f4a-9bcf-f5dae874c730",
        "taxRateId": "50c0d53b-8460-41e6-b4e9-a4e157fc1a64"
      }
    ],
    "firstBillingDate": "2022-02-02",
    "autoIssueInvoices": false,
    "purchaseOrderNumber": "PO123",
    "reference": "ref",
    "label": "label",
    "recurrenceDayOfMonth": 1,
    "planId": "6dc54805-0ac8-4f17-9341-4d3f2db9dcd8",
    "type": "PLAN"
  },
  "futureVersions": [
    {
      "id": "053e77bf-2a7a-4c3b-bd7f-689959d848a6",
      "version": 2,
      "validityPeriod": {
        "startDate": "2023-01-01",
        "endDate": "+999999999-12-31"
      },
      "startDate": "2022-01-01",
      "endDate": "2022-12-01",
      "taxRates": [
        {
          "priceId": "bc61d4b8-e9d6-4f4a-9bcf-f5dae874c730",
          "taxRateId": "50c0d53b-8460-41e6-b4e9-a4e157fc1a64"
        }
      ],
      "firstBillingDate": "2022-02-02",
      "autoIssueInvoices": false,
      "purchaseOrderNumber": "PO123",
      "reference": "ref",
      "label": "label",
      "recurrenceDayOfMonth": 1,
      "priceIds": [
        "bc61d4b8-e9d6-4f4a-9bcf-f5dae874c730"
      ],
      "type": "CUSTOM"
    }
  ],
  "startDate": "2022-01-01",
  "endDate": "2022-12-01",
  "taxRates": [
    {
      "priceId": "bc61d4b8-e9d6-4f4a-9bcf-f5dae874c730",
      "taxRateId": "50c0d53b-8460-41e6-b4e9-a4e157fc1a64"
    }
  ],
  "firstBillingDate": "2022-02-02",
  "autoIssueInvoices": false,
  "purchaseOrderNumber": "PO123",
  "reference": "ref",
  "label": "label",
  "recurrenceDayOfMonth": 1,
  "priceIds": [],
  "prices": [],
  "type": "CUSTOM",
  "createdAt": "2022-06-28T16:47:00Z",
  "updatedAt": "2022-06-28T16:47:00Z",
  "lastInvoiceId": "bdbf78a5-b007-4d46-aa7d-d0417a649d64",
  "timeTravellerId": "43f3dad8-23b0-4141-8813-4260b86a7ebb",
  "phases": [
    {
      "id": "6dc54805-0ac8-4f17-9341-4d3f2db9dcd8",
      "createdAt": "2022-06-28T16:47:00Z",
      "billingScheduleId": "b102e007-f5d7-4b1a-8a1d-9a51135ae73b",
      "priceIds": [
        "6dc54805-0ac8-4f17-9341-4d3f2db9dcd8"
      ],
      "startDate": "2022-01-01",
      "endDate": "2022-06-30",
      "discounts": [
        {
          "restrictToPrices": [
            "6dc54805-0ac8-4f17-9341-4d3f2db9dcd8"
          ],
          "type": "PERCENTAGE",
          "amount": 0.15,
          "message": "15% Discount",
          "separateLineItem": true
        }
      ],
      "minimums": [
        {
          "id": "6dc54805-0ac8-4f17-9341-4d3f2db9dcd8",
          "sequenceAccountId": "c4602d51-0fb4-4b48-b689-6ba28f540d1e",
          "billingScheduleId": "b102e007-f5d7-4b1a-8a1d-9a51135ae73b",
          "phaseId": "6dc54805-0ac8-4f17-9341-4d3f2db9dcd8",
          "amount": 100,
          "restrictToPrices": [
            "6dc54805-0ac8-4f17-9341-4d3f2db9dcd8"
          ],
          "createdAt": "2022-06-28T16:47:00Z",
          "updatedAt": "2022-06-28T16:47:00Z"
        }
      ]
    }
  ],
  "archivedAt": "2022-06-28T16:47:00Z",
  "rollUpBilling": false
}

Headers

Authorization
string
required

Your API credentials. Eg. Basic {credentials}.

Path Parameters

billingScheduleId
string
required

Billing Schedule ID

Response

200 - application/json
id
string
required

Billing Schedule ID

sequenceAccountId
string
required

Sequence Account ID

customerId
string
required

Customer ID

status
enum<string>
required

Status

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

Start date

endDate
string
required

End date

taxRates
object[]

Tax Rate for each Product

firstBillingDate
string

First billing date

autoIssueInvoices
boolean
required

Auto-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[]
required

Price IDs

prices
any[]
required

Prices

type
enum<string>
required

Billing schedule type

Available options:
CUSTOM,
PLAN,
PHASES
createdAt
string
required

Created at

updatedAt
string
required

Last updated at

lastInvoiceId
string

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

timeTravellerId
string

Time traveller ID

phases
object[]
required

Phases

archivedAt
string

Archived at

rollUpBilling
boolean
required

Roll up billing