PUT
/
prices
/
{id}
curl --request PUT \
  --url https://eu.sequencehq.com/api/prices/{id} \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "Demo Product"
}'
{
  "id": "bc61d4b8-e9d6-4f4a-9bcf-f5dae874c730",
  "sequenceAccountId": "1986c663-9ee9-4811-bfbf-57d2ad666096",
  "productId": "d07037d5-3e31-4c3a-a360-e58555e2bf44",
  "name": "Demo Product",
  "currency": "GBP",
  "structure": {
    "pricingType": "LINEAR",
    "pricePerUnit": "0.25",
    "usageMetricId": "9aa108d7-6b12-4f5e-8288-5779b9d95b5e",
    "isPricePercentage": false
  },
  "billingFrequency": "MONTHLY",
  "billingType": "IN_ARREARS",
  "createdAt": "2022-06-28T16:47:00Z",
  "updatedAt": "2022-06-28T16:47:00Z",
  "externalIds": [
    {
      "key": "Xero",
      "value": "123"
    }
  ],
  "parameters": [
    {
      "parameterId": "94703530-1293-479b-bd37-ccad42fd9c8b",
      "value": "10"
    }
  ]
}

Headers

Authorization
string
required

Your API credentials. Eg. Basic {credentials}.

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

sequenceAccountId
string
required

The Sequence Account to which this Price belongs

productId
string
required

The ID of the Product for which this Price provides pricing

name
string
required

The customer-facing name of this Price

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
structure
object
required

The item pricing structure

billingFrequency
enum<string>
required

The recurrence of charging this price.

Available options:
ONE_TIME,
MONTHLY,
QUARTERLY,
YEARLY
billingType
enum<string>
required

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

Available options:
IN_ARREARS,
IN_ADVANCE
createdAt
string
required

Created at

updatedAt
string

Updated At

externalIds
object[]
required

IDs in external integrations

parameters
object[]
required

Parameters required for usage calculation