Skip to main content
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>'
{
  "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": "<string>",
        "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": "<string>",
          "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": "<string>",
            "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": "<string>",
              "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": "<string>",
                "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
}

Documentation Index

Fetch the complete documentation index at: https://docs2.zenskar.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
x-api-key
string
header
default:<your-api-key>
required
​
organisation
string
header
default:<your-organisation-id>
required

Path Parameters

​
product_id
string<uuid>
required

Query Parameters

​
cursor
string | null

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="

​
limit
integer | null

The number of results to return - defaults to 10

Example:

10

​
order
string | null
default:-created_at
Example:

"order=created_at"

​
pricing_type
enum<string> | null
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
​
pricing_type__in
string | null
​
name
string | null
​
name__ilike
string | null
​
link_id
string | null
​
link_id__ilike
string | null
​
created_at
string<date-time> | null
​
created_at__gt
string<date-time> | null
​
created_at__gte
string<date-time> | null
​
created_at__lt
string<date-time> | null
​
created_at__lte
string<date-time> | null

Response

Successful Response

​
results
ProductBundlePricingResponseSchema · object[]
required

The results for the current page

​
next
string | null

The cursor for the next page of results

Example:

"V2VsbCBhcmV1IGN1cmlvdxM="

​
previous
string | null

The cursor for the previous page of results

Example:

"GmBsbCBhcmV1IGN1cmlvdxM="

​
total_count
integer | null

The total count of rows