Prices
Update a Price
Update a Price
PUT
/
prices
/
{id}
Headers
Authorization
string
requiredYour API credentials. Eg. Basic {credentials}
.
Sequence-Version
enum<string>
Use this header to select an API version
Available options:
2024-01-01
Path Parameters
id
string
requiredUnique Price ID
Body
application/json
name
string
requiredThe customer-facing name of this Price
Response
200 - application/json
id
string
requiredUnique Price ID
sequenceAccountId
string
requiredThe Sequence Account to which this Price belongs
productId
string
requiredThe ID of the Product for which this Price provides pricing
name
string
requiredThe customer-facing name of this Price
currency
enum<string>
requiredThe 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
requiredbillingFrequency
enum<string>
requiredThe recurrence of charging this price.
Available options:
ONE_TIME
, MONTHLY
, QUARTERLY
, YEARLY
billingType
enum<string>
requiredHow to bill this price: in-arrears or in-advance.
Available options:
IN_ARREARS
, IN_ADVANCE
createdAt
string
requiredCreated at
updatedAt
string
Updated At
externalIds
object[]
requiredIDs in external integrations
parameters
object[]
requiredParameters required for usage calculation
listPriceId
string
The list price ID, if this price variant was created from a list price
usageCalculationPeriod
object
The period over which usage is aggregated.