Skip to main content
GET
/
products
/
bundle
/
{product_id}
/
pricing
/
{pricing_id}
Get product bundle pricing
curl --request GET \
  --url https://api.zenskar.com/products/bundle/{product_id}/pricing/{pricing_id} \
  --header 'organisation: <api-key>' \
  --header 'x-api-key: <api-key>'
{
  "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": []
      }
    }
  ]
}

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
​
pricing_id
string<uuid>
required

Response

Successful Response

​
id
string<uuid>
required

Pricing Model ID

​
pricing_data
MatrixPricing · object
required

Pricing Data

​
name
string | null

Pricing Model Name

​
description
string | null

Pricing Model Description

​
quantity
QuantityResponse · object

Quantity

​
grants
GrantResponse · object[] | null

Grants

​
consumptions
ConsumptionResponse · object[] | null

Consumptions

​
link_id
string | null

Parent Link ID

​
free_units
FreeUnit · object[] | null

Free Units

​
discounts
Discount · object[] | null

Discounts

​
commitments
Commitment · object[] | null

Commitments

​
taxes
Taxes · object[] | null

Taxes

​
payment_terms
PaymentTerms · object[] | null

Payment Terms

​
service_fees
ServiceFee · object[] | null

Service Fees

​
execution_logic
ExecutionLogic · object

Execution Logic

​
is_recurring
boolean | null

Is Recurring or not

​
billing_period
Period · object

Billing Cadence

​
add_to_catalog
boolean | null
default:true

Part of product catalog or not

​
overage_pricing
ProductPricingResponseSchema · object

Overage Pricing Configuration

​
usage_report_configs
ProductPricingUsageAssociationResponseSchema · object[] | null

Usage Report Configurations associated with the pricing model

​
products
ProductInBundleResponseSchema · object[] | null

List of Bundled Products