List all Prices

GET

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

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.

currency

string

Filter by currency.

name

string

Filter by name.

billingFrequency

string

Filter by billing frequency.

productId

string

Filter by product ID.

Response

200 - application/json

items

object[]

required

Prices

items.id

string

required

Unique Price ID, generated by Sequence on creation.

items.productId

string

required

The ID of the Product that this Price is associated with.

items.name

string

required

A short form description of the price, which appears as the title of line items on invoices.

items.currency

enum<string>

required

The currency in which this price is denominated. This must be a valid ISO 4217 currency code, that is currently part of currencies supported by Sequence.

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 for this price. This can be a simple fixed price, or a more complex structure that varies based on usage.

items.billingFrequency

enum<string>

required

The frequency with which this price is billed.

Available options:

ON_DEMAND,

ONE_TIME,

MONTHLY,

QUARTERLY,

YEARLY

items.billingType

enum<string>

required

Indicate at which point of the billing period to generate the invoice for this price. This can be either in-arrears (after the period ends), or in-advnace (at the beginning of the period).

Available options:

IN_ARREARS,

IN_ADVANCE

items.createdAt

string

required

Time at which the Price was initially created, in ISO 8601 format.

items.updatedAt

string

Time at which the Price was last updated, in ISO 8601 format.

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 custom metric. Please speak to your Sequence contacts for further information prior to usage.

items.listPriceId

string

The list price ID, if this price variant was created from a list price

items.usageCalculationPeriod

object

The period over which usage is aggregated.

pagination

object

required

Results pagination

List all billing products Create a new Price

API Reference

Latest Live API

Version 2024-07-30

Headers

Query Parameters

Response