PUT
/
prices
/
{id}
{
  "id": "bc61d4b8-e9d6-4f4a-9bcf-f5dae874c730",
  "productId": "d07037d5-3e31-4c3a-a360-e58555e2bf44",
  "name": "Demo Product",
  "currency": "GBP",
  "structure": {
    "tiers": [
      {
        "upperBound": "200",
        "price": "1.00",
        "fee": "50.00",
        "isPricePercentage": false
      },
      {
        "upperBound": "400",
        "price": "0.75",
        "fee": "25.00",
        "isPricePercentage": false
      },
      {
        "price": "0.50",
        "fee": "0.00",
        "isPricePercentage": false
      }
    ],
    "usageMetricId": "04c62961-04ba-48e6-b985-758bb7d3e712",
    "usageCalculationMode": "BILLING_PERIOD",
    "pricingType": "GRADUATED"
  },
  "billingFrequency": "MONTHLY",
  "billingType": "IN_ARREARS",
  "createdAt": "2022-06-28T16:47:00Z",
  "updatedAt": "2022-06-28T16:47:00Z",
  "integrationIds": [
    {
      "service": "Xero",
      "id": "123"
    }
  ],
  "customMetricParameters": [
    {
      "parameterId": "94703530-1293-479b-bd37-ccad42fd9c8b",
      "value": "10"
    }
  ],
  "listPriceId": "b4d7e884-e007-4183-8355-4771865c5100",
  "usageCalculationPeriod": {
    "frequency": "MONTHLY",
    "interval": 1
  }
}

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 Price ID

Body

application/json
name
string
required

The customer-facing name of this Price

Response

200 - application/json
id
string
required

Unique Price ID, generated by Sequence on creation.

productId
string
required

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

name
string
required

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

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

billingFrequency
enum<string>
required

The frequency with which this price is billed.

Available options:
ONE_TIME,
MONTHLY,
QUARTERLY,
YEARLY
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
createdAt
string
required

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

updatedAt
string

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

integrationIds
object[]
required

Alternate IDs for this Price in third-party integration systems

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.

listPriceId
string

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

Get a Price by IDDelete a Price