GET
/
billing-schedules
curl --request GET \
  --url https://eu.sequencehq.com/api/billing-schedules \
  --header 'Authorization: <authorization>'
{
  "items": [
    {
      "id": "b102e007-f5d7-4b1a-8a1d-9a51135ae73b",
      "sequenceAccountId": "c4602d51-0fb4-4b48-b689-6ba28f540d1e",
      "customerId": "cca32597-b6b0-4499-9669-128aef8702e4",
      "status": "ACTIVE",
      "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",
      "priceIds": [
        "bc61d4b8-e9d6-4f4a-9bcf-f5dae874c730"
      ],
      "prices": [
        {
          "id": "bc61d4b8-e9d6-4f4a-9bcf-f5dae874c730",
          "sequenceAccountId": "c4602d51-0fb4-4b48-b689-6ba28f540d1e",
          "productId": "f409d651-c475-4142-aafd-a5d2bd74d4f9",
          "name": "Demo Product",
          "currency": "GBP",
          "structure": {
            "pricingType": "LINEAR",
            "pricePerUnit": "0.25",
            "usageMetricId": "04c62961-04ba-48e6-b985-758bb7d3e712",
            "isPricePercentage": false
          },
          "billingFrequency": "MONTHLY",
          "billingType": "IN_ARREARS",
          "createdAt": "2022-06-28T16:47:00Z",
          "updatedAt": "2022-06-28T16:47:00Z",
          "deletedAt": "2022-06-28T16:47:00Z",
          "externalIds": [],
          "parameters": [
            {
              "parameterId": "94703530-1293-479b-bd37-ccad42fd9c8b",
              "value": "10"
            }
          ],
          "listPriceId": "b4d7e884-e007-4183-8355-4771865c5100"
        }
      ],
      "type": "PLAN",
      "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
    }
  ],
  "pagination": {
    "after": "MDE4NDUyNjYtNmQ2NC03N2M4LTlhZGYtNDQ4N2Q5NGQxNDU3",
    "before": "MDE4NDQyMWUtYTljYy03MTFiLWFmOTMtYmYwNTExZDRkODMz",
    "totalResultSize": 10
  }
}

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-05-09

Query Parameters

label
string

Filter by label.

planId
string

Filter by plan ID.

customerId
string

Filter by customer ID.

billingScheduleStatus
string

Filter by status.

autoSendInvoices
string

Filter by auto send invoices.

sortBy
string

Sort column. Default: creation time.

includeArchivedSchedules
string

Include archived schedules.

before
string

Pagination cursor. To page through items, omit this parameter to retrieve the first page, and then successively use the value you get from pagination.after or pagination.before to retrieve each page.

after
string

Pagination cursor. To page through items, omit this parameter to retrieve the first page, and then successively use the value you get from pagination.after or pagination.before to retrieve each page.

limit
integer

Maximum number of objects to return per-page.

sortOrder
string

Sort order. Default: DESC (descending, most often used for reverse chronological sorting).

Response

200 - application/json
items
object[]
required

Billing Schedules

pagination
object
required

Results pagination