POST
/
prices
Header
Body
curl --request POST \
  --url https://eu.sequencehq.com/api/prices \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: application/json' \
  --data '{
  "billingFrequency": "QUARTERLY",
  "billingType": "IN_ARREARS",
  "currency": "GBP",
  "externalIds": [
    {
      "key": "Xero",
      "value": "123"
    }
  ],
  "name": "Demo Product",
  "productId": "d07037d5-3e31-4c3a-a360-e58555e2bf44",
  "structure": "<structure>"
}'
{
  "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",
  "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

Authorizationrequired
string

Your API credentials. Eg. Basic {credentials}.

Idempotency-Key
string

Specifying a unique ID for this request here lets you retry it without risk of performing the same operation twice.

Body

application/json
billingFrequencyrequired
enum<string>
Available options:
ONE_TIME,
DAILY,
WEEKLY,
MONTHLY,
QUARTERLY,
YEARLY
billingTyperequired
enum<string>
Available options:
IN_ARREARS,
IN_ADVANCE
currencyrequired
enum<string>
Available options:
GBP,
EUR,
USD,
CAD,
ZAR,
ARS,
UYU,
COP,
MXN,
AUD
externalIdsrequired
object[]
namerequired
string
productIdrequired
string
structurerequired
object

Response

201 - application/json
billingFrequencyrequired
enum<string>
Available options:
ONE_TIME,
DAILY,
WEEKLY,
MONTHLY,
QUARTERLY,
YEARLY
billingTyperequired
enum<string>
Available options:
IN_ARREARS,
IN_ADVANCE
createdAtrequired
string
currencyrequired
enum<string>
Available options:
GBP,
EUR,
USD,
CAD,
ZAR,
ARS,
UYU,
COP,
MXN,
AUD
externalIdsrequired
object[]
idrequired
string
namerequired
string
productIdrequired
string
sequenceAccountIdrequired
string
structurerequired
object
updatedAt
string
Get a Price by IDUpdate a Price