GET
/
plans
Header
Query
curl --request GET \
  --url https://eu.sequencehq.com/api/plans \
  --header 'Authorization: <authorization>'
{
  "items": [
    {
      "createdAt": "2022-09-01T16:47:00Z",
      "currency": "GBP",
      "eligibleCustomerIds": [],
      "id": "fe0916b3-6a3f-4e02-abf0-dfcc6b3bc471",
      "label": "Sample plan - EU",
      "minimum": "100.00",
      "name": "Sample plan",
      "parentId": "10f0390c-ba18-404d-ae4e-256257eaa0fd",
      "prices": [
        {
          "billingFrequency": "MONTHLY",
          "billingType": "IN_ARREARS",
          "createdAt": "2022-06-28T16:47:00Z",
          "currency": "GBP",
          "deletedAt": "2022-06-28T16:47:00Z",
          "externalIds": [
            {
              "key": "Xero",
              "value": "123"
            }
          ],
          "id": "bc61d4b8-e9d6-4f4a-9bcf-f5dae874c730",
          "name": "Demo Product",
          "productId": "f409d651-c475-4142-aafd-a5d2bd74d4f9",
          "sequenceAccountId": "c4602d51-0fb4-4b48-b689-6ba28f540d1e",
          "structure": {
            "isPricePercentage": false,
            "pricePerUnit": "0.25",
            "pricingType": "LINEAR",
            "usageMetricId": "04c62961-04ba-48e6-b985-758bb7d3e712"
          },
          "updatedAt": "2022-06-28T16:47:00Z"
        }
      ],
      "schedulesCount": 0,
      "sequenceAccountId": "c4602d51-0fb4-4b48-b689-6ba28f540d1e",
      "status": "LIVE",
      "type": "REUSABLE",
      "updatedAt": "2022-09-01T16:47:00Z",
      "version": 1,
      "versionChangeBehaviour": "IMMEDIATE",
      "versionEffectiveFrom": "2022-09-01T00:00:00Z"
    }
  ],
  "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

after
string

Provide this parameter with a returned offset to retrieve the next page of entities after the given offset. Omit this parameter alongside 'before' in order to retrieve the first page of results

before
string

Provide this parameter with a returned offset to retrieve the next page of entities before the given offset. Omit this parameter alongside 'after' in order to retrieve the first page of results

limit
integer

Maximum number of objects to return per-page.

name
string

Filter by name.

createdBefore
string

Filter by created before date.

createdAfter
string

Filter by created after date.

type
string

Filter by plan type.

sortBy
string

Sort column. Default: creation time.

Response

200 - application/json
itemsrequired
object[]
paginationrequired
object
Update Billing SchedulesGet Plan