Get product pricings
curl --request GET \
--url https://api.zenskar.com/products/{product_id}/pricing \
--header 'organisation: <api-key>' \
--header 'x-api-key: <api-key>'import requests
url = "https://api.zenskar.com/products/{product_id}/pricing"
headers = {
"x-api-key": "<api-key>",
"organisation": "<api-key>"
}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-api-key': '<api-key>', organisation: '<api-key>'}};
fetch('https://api.zenskar.com/products/{product_id}/pricing', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.zenskar.com/products/{product_id}/pricing",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"organisation: <api-key>",
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.zenskar.com/products/{product_id}/pricing"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("organisation", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.zenskar.com/products/{product_id}/pricing")
.header("x-api-key", "<api-key>")
.header("organisation", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.zenskar.com/products/{product_id}/pricing")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'
request["organisation"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"results": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"pricing_data": {
"unit_amount": 123,
"dimensions": [
{
"name": "<string>",
"column_name": "<string>"
}
],
"prices": [
1
],
"display_alias": [
"<string>"
],
"pricing_type": "matrix",
"currency": "<string>",
"label": "<string>",
"unit": "<string>",
"pricing_period": {
"cadence": "<string>"
}
},
"name": "<string>",
"description": "<string>",
"quantity": {
"type": "metered",
"label": "<string>",
"quantity": 123,
"unit": "<string>",
"aggregate_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"quantity_entries": [
{
"value": 123,
"effective_from": "2023-12-25",
"created_at": "2023-11-07T05:31:56Z",
"description": "<string>"
}
],
"trigger_event": "invoice_approval",
"expires_at": "end_of_product_billing_period",
"expiry_period": "<string>",
"grant_frequency_same_as_product": true,
"grant_frequency": "<string>",
"feature_option_value": "<string>",
"numeric_value": 123,
"allow_mid_cycle_cancellation": false,
"constraints": {
"min": 1,
"max": 1
},
"aggregate": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"dataschema": "<string>",
"aggregation_query": "<string>",
"cust_agg_query": "<string>",
"visual_query_builder": {},
"datasource": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"created_at": "2023-11-07T05:31:56Z"
}
},
"grants": [],
"consumptions": [],
"link_id": "<string>",
"free_units": [],
"discounts": [],
"commitments": [],
"taxes": [],
"payment_terms": [],
"service_fees": [],
"execution_logic": {
"additional_steps": [
{
"node_type": "<string>",
"inputs": {},
"step_name": "<string>",
"id": "<string>"
}
]
},
"is_recurring": true,
"billing_period": {
"offset": "prepaid",
"cadence": "<string>"
},
"add_to_catalog": true,
"overage_pricing": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"pricing_data": {
"unit_amount": 123,
"dimensions": [
{
"name": "<string>",
"column_name": "<string>"
}
],
"prices": [
1
],
"display_alias": [
"<string>"
],
"pricing_type": "matrix",
"currency": "<string>",
"label": "<string>",
"unit": "<string>",
"pricing_period": {
"cadence": "<string>"
}
},
"name": "<string>",
"description": "<string>",
"quantity": {
"type": "metered",
"label": "<string>",
"quantity": 123,
"unit": "<string>",
"aggregate_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"quantity_entries": [
{
"value": 123,
"effective_from": "2023-12-25",
"created_at": "2023-11-07T05:31:56Z",
"description": "<string>"
}
],
"trigger_event": "invoice_approval",
"expires_at": "end_of_product_billing_period",
"expiry_period": "<string>",
"grant_frequency_same_as_product": true,
"grant_frequency": "<string>",
"feature_option_value": "<string>",
"numeric_value": 123,
"allow_mid_cycle_cancellation": false,
"constraints": {
"min": 1,
"max": 1
},
"aggregate": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"dataschema": "<string>",
"aggregation_query": "<string>",
"cust_agg_query": "<string>",
"visual_query_builder": {},
"datasource": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"created_at": "2023-11-07T05:31:56Z"
}
},
"grants": [],
"consumptions": [],
"link_id": "<string>",
"free_units": [],
"discounts": [],
"commitments": [],
"taxes": [],
"payment_terms": [],
"service_fees": [],
"execution_logic": {
"additional_steps": [
{
"node_type": "<string>",
"inputs": {},
"step_name": "<string>",
"id": "<string>"
}
]
},
"is_recurring": true,
"billing_period": {
"offset": "prepaid",
"cadence": "<string>"
},
"add_to_catalog": true,
"overage_pricing": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"pricing_data": {
"unit_amount": 123,
"dimensions": [
{
"name": "<string>",
"column_name": "<string>"
}
],
"prices": [
1
],
"display_alias": [
"<string>"
],
"pricing_type": "matrix",
"currency": "<string>",
"label": "<string>",
"unit": "<string>",
"pricing_period": {
"cadence": "<string>"
}
},
"name": "<string>",
"description": "<string>",
"quantity": {
"type": "metered",
"label": "<string>",
"quantity": 123,
"unit": "<string>",
"aggregate_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"quantity_entries": [
{
"value": 123,
"effective_from": "2023-12-25",
"created_at": "2023-11-07T05:31:56Z",
"description": "<string>"
}
],
"trigger_event": "invoice_approval",
"expires_at": "end_of_product_billing_period",
"expiry_period": "<string>",
"grant_frequency_same_as_product": true,
"grant_frequency": "<string>",
"feature_option_value": "<string>",
"numeric_value": 123,
"allow_mid_cycle_cancellation": false,
"constraints": {
"min": 1,
"max": 1
},
"aggregate": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"dataschema": "<string>",
"aggregation_query": "<string>",
"cust_agg_query": "<string>",
"visual_query_builder": {},
"datasource": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"created_at": "2023-11-07T05:31:56Z"
}
},
"grants": [],
"consumptions": [],
"link_id": "<string>",
"free_units": [],
"discounts": [],
"commitments": [],
"taxes": [],
"payment_terms": [],
"service_fees": [],
"execution_logic": {
"additional_steps": [
{
"node_type": "<string>",
"inputs": {},
"step_name": "<string>",
"id": "<string>"
}
]
},
"is_recurring": true,
"billing_period": {
"offset": "prepaid",
"cadence": "<string>"
},
"add_to_catalog": true,
"usage_report_configs": []
},
"usage_report_configs": []
},
"usage_report_configs": [],
"products": [
{
"product": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"type": "product",
"description": "<string>",
"tags": [
"<unknown>"
],
"sku": "<string>",
"parent_link_id": "<string>",
"tax_codes": {},
"is_active": true,
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"default_pricing_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"custom_attributes": {},
"product_category": "group",
"product_type": "time_dependent",
"product_sub_type": "quantity",
"track_usage": true,
"enum_values": [
"<string>"
],
"unit": "<string>",
"entitlements": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"description": "<string>",
"entitlement_type": "Feature",
"units": "<string>",
"is_active": true,
"product_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"created_at": "2023-11-07T05:31:56Z"
}
]
},
"pricing_model": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"pricing_data": {
"unit_amount": 123,
"dimensions": [
{
"name": "<string>",
"column_name": "<string>"
}
],
"prices": [
1
],
"display_alias": [
"<string>"
],
"pricing_type": "matrix",
"currency": "<string>",
"label": "<string>",
"unit": "<string>",
"pricing_period": {
"cadence": "<string>"
}
},
"name": "<string>",
"description": "<string>",
"quantity": {
"type": "metered",
"label": "<string>",
"quantity": 123,
"unit": "<string>",
"aggregate_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"quantity_entries": [
{
"value": 123,
"effective_from": "2023-12-25",
"created_at": "2023-11-07T05:31:56Z",
"description": "<string>"
}
],
"trigger_event": "invoice_approval",
"expires_at": "end_of_product_billing_period",
"expiry_period": "<string>",
"grant_frequency_same_as_product": true,
"grant_frequency": "<string>",
"feature_option_value": "<string>",
"numeric_value": 123,
"allow_mid_cycle_cancellation": false,
"constraints": {
"min": 1,
"max": 1
},
"aggregate": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"dataschema": "<string>",
"aggregation_query": "<string>",
"cust_agg_query": "<string>",
"visual_query_builder": {},
"datasource": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"created_at": "2023-11-07T05:31:56Z"
}
},
"grants": [],
"consumptions": [],
"link_id": "<string>",
"free_units": [],
"discounts": [],
"commitments": [],
"taxes": [],
"payment_terms": [],
"service_fees": [],
"execution_logic": {
"additional_steps": [
{
"node_type": "<string>",
"inputs": {},
"step_name": "<string>",
"id": "<string>"
}
]
},
"is_recurring": true,
"billing_period": {
"offset": "prepaid",
"cadence": "<string>"
},
"add_to_catalog": true,
"overage_pricing": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"pricing_data": {
"unit_amount": 123,
"dimensions": [
{
"name": "<string>",
"column_name": "<string>"
}
],
"prices": [
1
],
"display_alias": [
"<string>"
],
"pricing_type": "matrix",
"currency": "<string>",
"label": "<string>",
"unit": "<string>",
"pricing_period": {
"cadence": "<string>"
}
},
"name": "<string>",
"description": "<string>",
"quantity": {
"type": "metered",
"label": "<string>",
"quantity": 123,
"unit": "<string>",
"aggregate_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"quantity_entries": [
{
"value": 123,
"effective_from": "2023-12-25",
"created_at": "2023-11-07T05:31:56Z",
"description": "<string>"
}
],
"trigger_event": "invoice_approval",
"expires_at": "end_of_product_billing_period",
"expiry_period": "<string>",
"grant_frequency_same_as_product": true,
"grant_frequency": "<string>",
"feature_option_value": "<string>",
"numeric_value": 123,
"allow_mid_cycle_cancellation": false,
"constraints": {
"min": 1,
"max": 1
},
"aggregate": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"dataschema": "<string>",
"aggregation_query": "<string>",
"cust_agg_query": "<string>",
"visual_query_builder": {},
"datasource": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"created_at": "2023-11-07T05:31:56Z"
}
},
"grants": [],
"consumptions": [],
"link_id": "<string>",
"free_units": [],
"discounts": [],
"commitments": [],
"taxes": [],
"payment_terms": [],
"service_fees": [],
"execution_logic": {
"additional_steps": [
{
"node_type": "<string>",
"inputs": {},
"step_name": "<string>",
"id": "<string>"
}
]
},
"is_recurring": true,
"billing_period": {
"offset": "prepaid",
"cadence": "<string>"
},
"add_to_catalog": true,
"usage_report_configs": []
},
"usage_report_configs": []
}
}
]
}
],
"next": "V2VsbCBhcmV1IGN1cmlvdxM=",
"previous": "GmBsbCBhcmV1IGN1cmlvdxM=",
"total_count": 123
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}Products
Get product pricings
Fetches all pricing models associated with a product.
GET
/
products
/
{product_id}
/
pricing
Get product pricings
curl --request GET \
--url https://api.zenskar.com/products/{product_id}/pricing \
--header 'organisation: <api-key>' \
--header 'x-api-key: <api-key>'import requests
url = "https://api.zenskar.com/products/{product_id}/pricing"
headers = {
"x-api-key": "<api-key>",
"organisation": "<api-key>"
}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-api-key': '<api-key>', organisation: '<api-key>'}};
fetch('https://api.zenskar.com/products/{product_id}/pricing', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.zenskar.com/products/{product_id}/pricing",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"organisation: <api-key>",
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.zenskar.com/products/{product_id}/pricing"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("organisation", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.zenskar.com/products/{product_id}/pricing")
.header("x-api-key", "<api-key>")
.header("organisation", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.zenskar.com/products/{product_id}/pricing")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'
request["organisation"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"results": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"pricing_data": {
"unit_amount": 123,
"dimensions": [
{
"name": "<string>",
"column_name": "<string>"
}
],
"prices": [
1
],
"display_alias": [
"<string>"
],
"pricing_type": "matrix",
"currency": "<string>",
"label": "<string>",
"unit": "<string>",
"pricing_period": {
"cadence": "<string>"
}
},
"name": "<string>",
"description": "<string>",
"quantity": {
"type": "metered",
"label": "<string>",
"quantity": 123,
"unit": "<string>",
"aggregate_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"quantity_entries": [
{
"value": 123,
"effective_from": "2023-12-25",
"created_at": "2023-11-07T05:31:56Z",
"description": "<string>"
}
],
"trigger_event": "invoice_approval",
"expires_at": "end_of_product_billing_period",
"expiry_period": "<string>",
"grant_frequency_same_as_product": true,
"grant_frequency": "<string>",
"feature_option_value": "<string>",
"numeric_value": 123,
"allow_mid_cycle_cancellation": false,
"constraints": {
"min": 1,
"max": 1
},
"aggregate": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"dataschema": "<string>",
"aggregation_query": "<string>",
"cust_agg_query": "<string>",
"visual_query_builder": {},
"datasource": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"created_at": "2023-11-07T05:31:56Z"
}
},
"grants": [],
"consumptions": [],
"link_id": "<string>",
"free_units": [],
"discounts": [],
"commitments": [],
"taxes": [],
"payment_terms": [],
"service_fees": [],
"execution_logic": {
"additional_steps": [
{
"node_type": "<string>",
"inputs": {},
"step_name": "<string>",
"id": "<string>"
}
]
},
"is_recurring": true,
"billing_period": {
"offset": "prepaid",
"cadence": "<string>"
},
"add_to_catalog": true,
"overage_pricing": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"pricing_data": {
"unit_amount": 123,
"dimensions": [
{
"name": "<string>",
"column_name": "<string>"
}
],
"prices": [
1
],
"display_alias": [
"<string>"
],
"pricing_type": "matrix",
"currency": "<string>",
"label": "<string>",
"unit": "<string>",
"pricing_period": {
"cadence": "<string>"
}
},
"name": "<string>",
"description": "<string>",
"quantity": {
"type": "metered",
"label": "<string>",
"quantity": 123,
"unit": "<string>",
"aggregate_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"quantity_entries": [
{
"value": 123,
"effective_from": "2023-12-25",
"created_at": "2023-11-07T05:31:56Z",
"description": "<string>"
}
],
"trigger_event": "invoice_approval",
"expires_at": "end_of_product_billing_period",
"expiry_period": "<string>",
"grant_frequency_same_as_product": true,
"grant_frequency": "<string>",
"feature_option_value": "<string>",
"numeric_value": 123,
"allow_mid_cycle_cancellation": false,
"constraints": {
"min": 1,
"max": 1
},
"aggregate": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"dataschema": "<string>",
"aggregation_query": "<string>",
"cust_agg_query": "<string>",
"visual_query_builder": {},
"datasource": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"created_at": "2023-11-07T05:31:56Z"
}
},
"grants": [],
"consumptions": [],
"link_id": "<string>",
"free_units": [],
"discounts": [],
"commitments": [],
"taxes": [],
"payment_terms": [],
"service_fees": [],
"execution_logic": {
"additional_steps": [
{
"node_type": "<string>",
"inputs": {},
"step_name": "<string>",
"id": "<string>"
}
]
},
"is_recurring": true,
"billing_period": {
"offset": "prepaid",
"cadence": "<string>"
},
"add_to_catalog": true,
"overage_pricing": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"pricing_data": {
"unit_amount": 123,
"dimensions": [
{
"name": "<string>",
"column_name": "<string>"
}
],
"prices": [
1
],
"display_alias": [
"<string>"
],
"pricing_type": "matrix",
"currency": "<string>",
"label": "<string>",
"unit": "<string>",
"pricing_period": {
"cadence": "<string>"
}
},
"name": "<string>",
"description": "<string>",
"quantity": {
"type": "metered",
"label": "<string>",
"quantity": 123,
"unit": "<string>",
"aggregate_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"quantity_entries": [
{
"value": 123,
"effective_from": "2023-12-25",
"created_at": "2023-11-07T05:31:56Z",
"description": "<string>"
}
],
"trigger_event": "invoice_approval",
"expires_at": "end_of_product_billing_period",
"expiry_period": "<string>",
"grant_frequency_same_as_product": true,
"grant_frequency": "<string>",
"feature_option_value": "<string>",
"numeric_value": 123,
"allow_mid_cycle_cancellation": false,
"constraints": {
"min": 1,
"max": 1
},
"aggregate": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"dataschema": "<string>",
"aggregation_query": "<string>",
"cust_agg_query": "<string>",
"visual_query_builder": {},
"datasource": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"created_at": "2023-11-07T05:31:56Z"
}
},
"grants": [],
"consumptions": [],
"link_id": "<string>",
"free_units": [],
"discounts": [],
"commitments": [],
"taxes": [],
"payment_terms": [],
"service_fees": [],
"execution_logic": {
"additional_steps": [
{
"node_type": "<string>",
"inputs": {},
"step_name": "<string>",
"id": "<string>"
}
]
},
"is_recurring": true,
"billing_period": {
"offset": "prepaid",
"cadence": "<string>"
},
"add_to_catalog": true,
"usage_report_configs": []
},
"usage_report_configs": []
},
"usage_report_configs": [],
"products": [
{
"product": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"type": "product",
"description": "<string>",
"tags": [
"<unknown>"
],
"sku": "<string>",
"parent_link_id": "<string>",
"tax_codes": {},
"is_active": true,
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"default_pricing_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"custom_attributes": {},
"product_category": "group",
"product_type": "time_dependent",
"product_sub_type": "quantity",
"track_usage": true,
"enum_values": [
"<string>"
],
"unit": "<string>",
"entitlements": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"description": "<string>",
"entitlement_type": "Feature",
"units": "<string>",
"is_active": true,
"product_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"created_at": "2023-11-07T05:31:56Z"
}
]
},
"pricing_model": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"pricing_data": {
"unit_amount": 123,
"dimensions": [
{
"name": "<string>",
"column_name": "<string>"
}
],
"prices": [
1
],
"display_alias": [
"<string>"
],
"pricing_type": "matrix",
"currency": "<string>",
"label": "<string>",
"unit": "<string>",
"pricing_period": {
"cadence": "<string>"
}
},
"name": "<string>",
"description": "<string>",
"quantity": {
"type": "metered",
"label": "<string>",
"quantity": 123,
"unit": "<string>",
"aggregate_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"quantity_entries": [
{
"value": 123,
"effective_from": "2023-12-25",
"created_at": "2023-11-07T05:31:56Z",
"description": "<string>"
}
],
"trigger_event": "invoice_approval",
"expires_at": "end_of_product_billing_period",
"expiry_period": "<string>",
"grant_frequency_same_as_product": true,
"grant_frequency": "<string>",
"feature_option_value": "<string>",
"numeric_value": 123,
"allow_mid_cycle_cancellation": false,
"constraints": {
"min": 1,
"max": 1
},
"aggregate": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"dataschema": "<string>",
"aggregation_query": "<string>",
"cust_agg_query": "<string>",
"visual_query_builder": {},
"datasource": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"created_at": "2023-11-07T05:31:56Z"
}
},
"grants": [],
"consumptions": [],
"link_id": "<string>",
"free_units": [],
"discounts": [],
"commitments": [],
"taxes": [],
"payment_terms": [],
"service_fees": [],
"execution_logic": {
"additional_steps": [
{
"node_type": "<string>",
"inputs": {},
"step_name": "<string>",
"id": "<string>"
}
]
},
"is_recurring": true,
"billing_period": {
"offset": "prepaid",
"cadence": "<string>"
},
"add_to_catalog": true,
"overage_pricing": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"pricing_data": {
"unit_amount": 123,
"dimensions": [
{
"name": "<string>",
"column_name": "<string>"
}
],
"prices": [
1
],
"display_alias": [
"<string>"
],
"pricing_type": "matrix",
"currency": "<string>",
"label": "<string>",
"unit": "<string>",
"pricing_period": {
"cadence": "<string>"
}
},
"name": "<string>",
"description": "<string>",
"quantity": {
"type": "metered",
"label": "<string>",
"quantity": 123,
"unit": "<string>",
"aggregate_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"quantity_entries": [
{
"value": 123,
"effective_from": "2023-12-25",
"created_at": "2023-11-07T05:31:56Z",
"description": "<string>"
}
],
"trigger_event": "invoice_approval",
"expires_at": "end_of_product_billing_period",
"expiry_period": "<string>",
"grant_frequency_same_as_product": true,
"grant_frequency": "<string>",
"feature_option_value": "<string>",
"numeric_value": 123,
"allow_mid_cycle_cancellation": false,
"constraints": {
"min": 1,
"max": 1
},
"aggregate": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"dataschema": "<string>",
"aggregation_query": "<string>",
"cust_agg_query": "<string>",
"visual_query_builder": {},
"datasource": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"created_at": "2023-11-07T05:31:56Z"
}
},
"grants": [],
"consumptions": [],
"link_id": "<string>",
"free_units": [],
"discounts": [],
"commitments": [],
"taxes": [],
"payment_terms": [],
"service_fees": [],
"execution_logic": {
"additional_steps": [
{
"node_type": "<string>",
"inputs": {},
"step_name": "<string>",
"id": "<string>"
}
]
},
"is_recurring": true,
"billing_period": {
"offset": "prepaid",
"cadence": "<string>"
},
"add_to_catalog": true,
"usage_report_configs": []
},
"usage_report_configs": []
}
}
]
}
],
"next": "V2VsbCBhcmV1IGN1cmlvdxM=",
"previous": "GmBsbCBhcmV1IGN1cmlvdxM=",
"total_count": 123
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}Authorizations
Path Parameters
Query Parameters
The cursor indicating a unique set of results - this should be auto generated and you get it from the next and previous fields of the response
Example:
"V2VsbCBhcmV1IGN1cmlvdxM="
The number of results to return - defaults to 10
Example:
10
Example:
"order=created_at"
Available options:
percent, per_unit, volume, volume_with_flat_fee, tiered, tiered_with_flat_fee, step, matrix, custom_tiered, package, flat_fee, features, two_dimensional_tiered, custom_pricing, bundle Response
Successful Response
The results for the current page
Show child attributes
Show child attributes
The cursor for the next page of results
Example:
"V2VsbCBhcmV1IGN1cmlvdxM="
The cursor for the previous page of results
Example:
"GmBsbCBhcmV1IGN1cmlvdxM="
The total count of rows