List Prices
Create a list price
Latest Live API
- Account
- Billing
- Collections
- Customer
- Invoices
- Notifications
- Product
- Quote
- Taxes
- Usage
Version 2024-07-30
- Account
- Billing
- Collections
- Customer
- Invoices
- Notifications
- Product
- Quote
- Taxes
- Usage
List Prices
Create a list price
Create a new list price
POST
/
list-prices
curl --request POST \
--url https://eu.sequencehq.com/api/list-prices \
--header 'Authorization: <authorization>' \
--header 'Content-Type: application/json' \
--data '{
"productId": "d07037d5-3e31-4c3a-a360-e58555e2bf44",
"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",
"billingType": "IN_ARREARS",
"integrationIds": [
{
"service": "Xero",
"id": "123"
}
],
"customMetricParameters": [
{
"parameterId": "94703530-1293-479b-bd37-ccad42fd9c8b",
"value": "10"
}
],
"usageCalculationPeriod": {
"frequency": "QUARTERLY",
"interval": 1
}
}'
{
"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
Your API credentials. Eg. Basic {credentials}
.
Use this header to select an API version
Available options:
2024-07-30
Body
application/json
Response
201
application/json
Created
The response is of type object
.
The response is of type object
.
The response is of type object
.
The response is of type object
.
The response is of type object
.
The response is of type object
.
The response is of type object
.
The response is of type object
.
curl --request POST \
--url https://eu.sequencehq.com/api/list-prices \
--header 'Authorization: <authorization>' \
--header 'Content-Type: application/json' \
--data '{
"productId": "d07037d5-3e31-4c3a-a360-e58555e2bf44",
"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",
"billingType": "IN_ARREARS",
"integrationIds": [
{
"service": "Xero",
"id": "123"
}
],
"customMetricParameters": [
{
"parameterId": "94703530-1293-479b-bd37-ccad42fd9c8b",
"value": "10"
}
],
"usageCalculationPeriod": {
"frequency": "QUARTERLY",
"interval": 1
}
}'
{
"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"
}
]
}