Skip to main content
POST
/
list-prices
/
{id}
/
archive
Archive a list price
curl --request POST \
  --url https://eu.sequencehq.com/api/list-prices/{id}/archive \
  --header 'Authorization: <authorization>'
{
  "id": "b4d7e884-e007-4183-8355-4771865c5100",
  "productId": "f409d651-c475-4142-aafd-a5d2bd74d4f9",
  "name": "Sample product",
  "currency": "GBP",
  "structure": {
    "tiers": [
      {
        "upperBound": "200",
        "price": "1.00",
        "fee": "50.00",
        "isPricePercentage": false
      },
      {
        "upperBound": "400",
        "price": "0.75",
        "fee": "25.00",
        "isPricePercentage": false
      },
      {
        "price": "0.50",
        "fee": "0.00",
        "isPricePercentage": false
      }
    ],
    "usageMetricId": "04c62961-04ba-48e6-b985-758bb7d3e712",
    "usageCalculationMode": "BILLING_PERIOD",
    "pricingType": "GRADUATED"
  },
  "billingFrequency": "MONTHLY",
  "usageCalculationPeriod": {
    "frequency": "QUARTERLY",
    "interval": 1
  },
  "billingType": "IN_ARREARS",
  "createdAt": "2021-08-25T12:00:00Z",
  "updatedAt": "2021-08-25T12:00:00Z",
  "integrationIds": [
    {
      "service": "Xero",
      "id": "123",
      "isPending": false
    }
  ],
  "customMetricParameters": [
    {
      "parameterId": "2963e49a-c8e0-4673-89f5-7a805c0faf14",
      "value": "10"
    }
  ]
}

Headers

​
Authorization
string
required

Your API credentials. Eg. Basic {credentials}.

​
Sequence-Version
enum<string>

Use this header to select an API version

Available options:
2024-07-30

Path Parameters

​
id
string
required

List Price Id

Response

OK

  • OneTimeListPriceResponse
  • FixedListPriceResponse
  • LinearListPriceResponse
  • PackageListPriceResponse
  • SeatBasedListPriceResponse
  • GraduatedListPriceResponse
  • VolumeListPriceResponse
​
id
string
required

Unique ID

Example:

"b4d7e884-e007-4183-8355-4771865c5100"

​
productId
string
required

The related product ID

Example:

"f409d651-c475-4142-aafd-a5d2bd74d4f9"

​
name
string
required

The customer-facing name of this list price

Example:

"Sample product"

​
currency
enum<string>
required

The pricing currency

Available options:
ARS,
AUD,
BRL,
BGN,
CAD,
CHF,
CLP,
CNY,
COP,
CZK,
DKK,
EGP,
EUR,
GBP,
HKD,
ILS,
INR,
ISK,
JPY,
KRW,
MXN,
NOK,
NZD,
PLN,
SEK,
SGD,
THB,
USD,
UYU,
ZAR
Example:

"GBP"

​
structure
object
required

The pricing structure

Example:
{
  "price": "150.00",
  "pricingType": "ONE_TIME"
}
​
billingFrequency
enum<string>
required

The recurrence of charging this price.

Available options:
ON_DEMAND,
ONE_TIME,
MONTHLY,
QUARTERLY,
HALF_YEARLY,
YEARLY
Example:

"MONTHLY"

​
billingType
enum<string>
required

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

Available options:
IN_ARREARS,
IN_ADVANCE
Example:

"IN_ARREARS"

​
createdAt
string
required

Creation timestamp. Formatted as an ISO 8601 timestamp.

Example:

"2021-08-25T12:00:00Z"

​
updatedAt
string
required

Timestamp when price was last updated. Formatted as an ISO 8601 timestamp.

Example:

"2021-08-25T12:00:00Z"

​
integrationIds
object[]
required

Alternate IDs for this price in third-party integration systems

Example:
[
  {
    "service": "Xero",
    "id": "123",
    "isPending": false
  }
]
​
customMetricParameters
object[]
required

Specific 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.

Example:
[
  {
    "parameterId": "2963e49a-c8e0-4673-89f5-7a805c0faf14",
    "value": "10"
  }
]