Skip to main content
GET
Get a list price

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

Path Parameters

id
string
required

Unique ID

Response

OK

id
string
required

Unique ID

Example:

"b4d7e884-e007-4183-8355-4771865c5100"

productId
string
required

The related product ID

Example:

"f409d651-c475-4142-aafd-a5d2bd74d4f9"

name
string
required

The customer-facing name of this list price

Example:

"Sample product"

currency
enum<string>
required

The pricing currency

Available options:
AED,
ARS,
AUD,
BRL,
BGN,
CAD,
CHF,
CLP,
CNY,
COP,
CZK,
DKK,
EGP,
EUR,
GBP,
HKD,
ILS,
INR,
ISK,
JPY,
KRW,
MXN,
NOK,
NZD,
PLN,
SAR,
SEK,
SGD,
THB,
USD,
UYU,
ZAR
Example:

"GBP"

structure
object
required

The pricing structure

Example:
billingFrequency
enum<string>
required

The recurrence of charging this price.

Available options:
ON_DEMAND,
ONE_TIME,
MONTHLY,
QUARTERLY,
HALF_YEARLY,
YEARLY,
PER_EVENT
Example:

"MONTHLY"

billingType
enum<string>
required

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

Available options:
IN_ARREARS,
IN_ADVANCE
Example:

"IN_ARREARS"

createdAt
string
required

Creation timestamp. Formatted as an ISO 8601 timestamp.

Example:

"2021-08-25T12:00:00Z"

updatedAt
string
required

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

Example:

"2021-08-25T12:00:00Z"

integrationIds
object[]
required

Alternate IDs for this price in third-party integration systems

Example:
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.

Example: