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"
}'
{
  "billingFrequency": "MONTHLY",
  "billingType": "IN_ARREARS",
  "createdAt": "2022-06-28T16:47:00Z",
  "currency": "GBP",
  "externalIds": [
    {
      "key": "Xero",
      "value": "123"
    }
  ],
  "id": "bc61d4b8-e9d6-4f4a-9bcf-f5dae874c730",
  "name": "Demo Product",
  "parameters": [
    {
      "parameterId": "94703530-1293-479b-bd37-ccad42fd9c8b",
      "value": "10"
    }
  ],
  "productId": "d07037d5-3e31-4c3a-a360-e58555e2bf44",
  "sequenceAccountId": "1986c663-9ee9-4811-bfbf-57d2ad666096",
  "structure": {
    "isPricePercentage": false,
    "pricePerUnit": "0.25",
    "pricingType": "LINEAR",
    "usageMetricId": "9aa108d7-6b12-4f5e-8288-5779b9d95b5e"
  },
  "updatedAt": "2022-06-28T16:47:00Z"
}

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
billingFrequency
enum<string>
required
Available options:
ONE_TIME,
MONTHLY,
QUARTERLY,
YEARLY
billingType
enum<string>
required
Available options:
IN_ARREARS,
IN_ADVANCE
createdAt
string
required

Created at

currency
enum<string>
required
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
externalIds
object[]
required

IDs in external integrations

id
string
required

Unique Price ID

name
string
required

The customer-facing name of this Price

parameters
object[]
required

Parameters required for usage calculation

productId
string
required

The ID of the Product for which this Price provides pricing

sequenceAccountId
string
required

The Sequence Account to which this Price belongs

structure
object
required

The item pricing structure

  • Option 1

  • Option 2

  • Option 3

  • Option 4

  • Option 5

  • Option 6

  • Option 7

updatedAt
string

Updated At