Sign in

v1

latestOpenAPI 3.0.02026-07-261733191.1 MB
List Prices

Archive a list price

Mark a list price as archived

post/list-prices/{id}/archive

Path parameters

idstring required

List Price Id

Headers

Authorizationstring required

Your API credentials. Eg. Basic {credentials}.

sequence-version'2024-07-30'

Use this header to select an API version

Response

OK

OR
OR
OR
OR
OR
OR

Example response

{
  "id": "b4d7e884-e007-4183-8355-4771865c5100",
  "productId": "f409d651-c475-4142-aafd-a5d2bd74d4f9",
  "name": "Sample product",
  "currency": "GBP",
  "structure": {
    "price": "150.00",
    "pricingType": "ONE_TIME"
  },
  "billingFrequency": "MONTHLY",
  "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"
    }
  ]
}