List Prices
Archive a list price
Mark a list price as archived
PUT
/
list-prices
/
{id}
/
archive
Headers
Authorization
string
requiredYour API credentials. Eg. Basic {credentials}
.
Sequence-Version
enum<string>
Use this header to select an API version
Available options:
2024-05-09
Path Parameters
id
string
requiredList Price Id
Response
200 - application/json
id
string
requiredUnique ID
productId
string
requiredThe related product ID
name
string
requiredThe customer-facing name of this list 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
requiredThe pricing structure
billingFrequency
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
requiredCreation timestamp. Formatted as an ISO 8601 timestamp.
updatedAt
string
requiredTimestamp when price was last updated. Formatted as an ISO 8601 timestamp.
integrationIds
object[]
requiredAlternate IDs for this price in third-party integration systems
customMetricParameters
object[]
requiredSpecific parameters to influence usage calculation for this price, and are only required when using a custom metric. Please speak to your Sequence contacts for further information prior to usage.