List all list prices

GET

list-prices

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-07-30

Query Parameters

currency

string

Filter by currency.

productId

string

Filter list prices by a given product ID.

billingFrequency

string

Filter by billing frequency.

includeArchived

boolean

Include archived list prices in results

limit

integer

Maximum number of objects to return per-page. Must be between 1 and 100 (inclusive).

after

string

Pagination offset. 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.

before

string

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

Response

200 - application/json

items

object[]

required

List prices

items.id

string

required

Unique ID

items.productId

string

required

The related product ID

items.name

string

required

The customer-facing name of this list price

items.currency

enum<string>

required

The pricing currency

Available options:

ARS,

AUD,

BRL,

CAD,

CHF,

CNY,

COP,

CZK,

DKK,

EUR,

GBP,

HKD,

ILS,

JPY,

KRW,

MXN,

NOK,

NZD,

PLN,

SEK,

SGD,

THB,

USD,

UYU,

ZAR

items.structure

object

required

The pricing structure

items.billingFrequency

enum<string>

required

The recurrence of charging this price.

Available options:

ON_DEMAND,

ONE_TIME,

MONTHLY,

QUARTERLY,

YEARLY

items.usageCalculationPeriod

object

The period over which usage is aggregated. This value is only taken into consideration and required with graduated pricing structures with a usage calculation mode of 'PERIOD'. It will be ignored for all non-graduated prices.

items.billingType

enum<string>

required

How to bill this price: in-arrears or in-advance.

Available options:

IN_ARREARS,

IN_ADVANCE

items.createdAt

string

required

Creation timestamp. Formatted as an ISO 8601 timestamp.

items.updatedAt

string

required

Timestamp when price was last updated. Formatted as an ISO 8601 timestamp.

items.integrationIds

object[]

required

Alternate IDs for this price in third-party integration systems

items.customMetricParameters

object[]

required

Specific parameters to influence usage calculation for this price, and are only required when using a custom metric. Please speak to your Sequence contacts for further information prior to usage.

pagination

object

required

Results pagination

Archive a product Create a list price

API Reference

Latest Live API

Version 2024-07-30

List all list prices

Headers

Query Parameters

Response