GET
/
billing-schedules
Header
Query
curl --request GET \
  --url https://eu.sequencehq.com/api/billing-schedules \
  --header 'Authorization: <authorization>'
{
  "items": [
    {
      "autoIssueInvoices": false,
      "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",
      "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": "PLAN"
    }
  ],
  "pagination": {
    "after": "MDE4NDUyNjYtNmQ2NC03N2M4LTlhZGYtNDQ4N2Q5NGQxNDU3",
    "before": "MDE4NDQyMWUtYTljYy03MTFiLWFmOTMtYmYwNTExZDRkODMz",
    "totalResultSize": 10
  }
}

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.

Query Parameters

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.

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
itemsrequired
object[]
paginationrequired
object
Delete a CustomerAliasGet Billing Schedule