Sign in

v1

latestOpenAPI 3.0.02026-07-261733191.1 MB
Prices

Create a new Price

Create a new Price

post/prices

Headers

Authorizationstring required

Your API credentials. Eg. Basic {credentials}.

sequence-version'2024-07-30'

Use this header to select an API version

Request body

OR
OR
OR
OR
OR
OR

Example request

{
  "productId": "d07037d5-3e31-4c3a-a360-e58555e2bf44",
  "name": "Demo Product",
  "currency": "GBP",
  "structure": {
    "price": "150.00",
    "pricingType": "ONE_TIME"
  },
  "billingFrequency": "MONTHLY",
  "billingType": "IN_ARREARS",
  "integrationIds": [
    {
      "service": "Xero",
      "id": "123"
    }
  ],
  "customMetricParameters": [
    {
      "parameterId": "94703530-1293-479b-bd37-ccad42fd9c8b",
      "value": "10"
    }
  ],
  "listPriceId": "b4d7e884-e007-4183-8355-4771865c5100",
  "status": "ACTIVE"
}

Response

Created

OR
OR
OR
OR
OR
OR

Example response

{
  "id": "bc61d4b8-e9d6-4f4a-9bcf-f5dae874c730",
  "productId": "d07037d5-3e31-4c3a-a360-e58555e2bf44",
  "name": "Demo Product",
  "currency": "GBP",
  "structure": {
    "price": "150.00",
    "pricingType": "ONE_TIME"
  },
  "billingFrequency": "MONTHLY",
  "billingType": "IN_ARREARS",
  "createdAt": "2022-06-28T16:47:00Z",
  "updatedAt": "2022-06-28T16:47:00Z",
  "integrationIds": [
    {
      "service": "Xero",
      "id": "123",
      "isPending": false
    }
  ],
  "customMetricParameters": [
    {
      "parameterId": "94703530-1293-479b-bd37-ccad42fd9c8b",
      "value": "10"
    }
  ],
  "listPriceId": "b4d7e884-e007-4183-8355-4771865c5100",
  "status": "ACTIVE"
}