Skip to main content
POST
/
contract_v2
/
{contract_id}
/
phases
/
{phase_id}
/
pricing
Create contract phase pricing
curl --request POST \
  --url https://api.zenskar.com/contract_v2/{contract_id}/phases/{phase_id}/pricing \
  --header 'Content-Type: application/json' \
  --header 'organisation: <api-key>' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "external_id": "<string>",
  "start_date": "2023-11-07T05:31:56Z",
  "end_date": "2023-11-07T05:31:56Z",
  "anchor_date": "2023-11-07T05:31:56Z",
  "pricing_id": "6cd431e4-d3d4-43dc-b0c4-9c6988a6c1b3",
  "product_id": "c19a0ece-63c3-412b-8549-e722bc28605d",
  "custom_data": {},
  "pricing": {
    "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
      }
    },
    "grants": [
      {
        "unit_amount": 123,
        "entitlement_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "type": "Feature",
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "identifier": "<string>",
        "priority": 123,
        "label": "<string>",
        "trigger_event": "invoice_approval",
        "expires_at": "end_of_product_billing_period",
        "expiry_period": "<string>",
        "grant_frequency_same_as_product": true,
        "grant_period": "<string>",
        "unit": "<string>",
        "period": {
          "cadence": "<string>"
        },
        "start_date": "2023-11-07T05:31:56Z",
        "feature_option_value": "<string>",
        "numeric_value": 123
      }
    ],
    "consumptions": [
      {
        "entitlement_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "type": "Feature",
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "identifier": "<string>",
        "priority": 123,
        "label": "<string>",
        "unit": "<string>",
        "show_additional_info": false,
        "trigger_event": "invoice_approval"
      }
    ],
    "link_id": "<string>",
    "free_units": [
      {
        "unit_amount": 123,
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "identifier": "<string>",
        "priority": 123,
        "label": "<string>",
        "unit": "<string>",
        "period": {
          "cadence": "<string>"
        }
      }
    ],
    "discounts": [
      {
        "type": "fixed",
        "unit_amount": 123,
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "identifier": "<string>",
        "priority": 123,
        "pricing_period": {
          "cadence": "<string>"
        },
        "label": "<string>"
      }
    ],
    "commitments": [
      {
        "type": "minimum_spend",
        "unit_amount": 123,
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "identifier": "<string>",
        "priority": 123,
        "currency": "<string>",
        "label": "<string>",
        "period": {
          "cadence": "<string>"
        },
        "charge_full_amount": false,
        "skip_zero_amount": false
      }
    ],
    "taxes": [
      {
        "type": "manual",
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "identifier": "<string>",
        "priority": 123,
        "label": "<string>",
        "code": "<string>",
        "unit_amount": 123
      }
    ],
    "payment_terms": [
      {
        "payment_term_type": "on_approval",
        "due_days": 123,
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "identifier": "<string>",
        "priority": 123,
        "label": "<string>",
        "payment_term_mode": "relative",
        "last_day_of_month": false
      }
    ],
    "service_fees": [
      {
        "type": "fixed",
        "unit_amount": 1,
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "identifier": "<string>",
        "priority": 123,
        "pricing_period": {
          "cadence": "<string>"
        },
        "label": "<string>"
      }
    ],
    "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": [
      {
        "aggregate_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "config": {},
        "is_default": false,
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      }
    ],
    "overage_pricing": {
      "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
        }
      },
      "grants": [
        {
          "unit_amount": 123,
          "entitlement_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "type": "Feature",
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "identifier": "<string>",
          "priority": 123,
          "label": "<string>",
          "trigger_event": "invoice_approval",
          "expires_at": "end_of_product_billing_period",
          "expiry_period": "<string>",
          "grant_frequency_same_as_product": true,
          "grant_period": "<string>",
          "unit": "<string>",
          "period": {
            "cadence": "<string>"
          },
          "start_date": "2023-11-07T05:31:56Z",
          "feature_option_value": "<string>",
          "numeric_value": 123
        }
      ],
      "consumptions": [
        {
          "entitlement_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "type": "Feature",
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "identifier": "<string>",
          "priority": 123,
          "label": "<string>",
          "unit": "<string>",
          "show_additional_info": false,
          "trigger_event": "invoice_approval"
        }
      ],
      "link_id": "<string>",
      "free_units": [
        {
          "unit_amount": 123,
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "identifier": "<string>",
          "priority": 123,
          "label": "<string>",
          "unit": "<string>",
          "period": {
            "cadence": "<string>"
          }
        }
      ],
      "discounts": [
        {
          "type": "fixed",
          "unit_amount": 123,
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "identifier": "<string>",
          "priority": 123,
          "pricing_period": {
            "cadence": "<string>"
          },
          "label": "<string>"
        }
      ],
      "commitments": [
        {
          "type": "minimum_spend",
          "unit_amount": 123,
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "identifier": "<string>",
          "priority": 123,
          "currency": "<string>",
          "label": "<string>",
          "period": {
            "cadence": "<string>"
          },
          "charge_full_amount": false,
          "skip_zero_amount": false
        }
      ],
      "taxes": [
        {
          "type": "manual",
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "identifier": "<string>",
          "priority": 123,
          "label": "<string>",
          "code": "<string>",
          "unit_amount": 123
        }
      ],
      "payment_terms": [
        {
          "payment_term_type": "on_approval",
          "due_days": 123,
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "identifier": "<string>",
          "priority": 123,
          "label": "<string>",
          "payment_term_mode": "relative",
          "last_day_of_month": false
        }
      ],
      "service_fees": [
        {
          "type": "fixed",
          "unit_amount": 1,
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "identifier": "<string>",
          "priority": 123,
          "pricing_period": {
            "cadence": "<string>"
          },
          "label": "<string>"
        }
      ],
      "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": [
        {
          "aggregate_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "config": {},
          "is_default": false,
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
        }
      ],
      "products": [
        {
          "product_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "product_pricing_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "product_pricing_data": "<unknown>"
        }
      ]
    },
    "products": [
      {
        "product_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "product_pricing_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "product_pricing_data": "<unknown>"
      }
    ]
  },
  "product": {
    "name": "<string>",
    "type": "product",
    "description": "<string>",
    "tags": [
      "<unknown>"
    ],
    "sku": "<string>",
    "parent_link_id": "<string>",
    "tax_codes": {},
    "is_active": true,
    "default_pricing_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "custom_attributes": {}
  },
  "plan_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "description": "<string>"
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "phase_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "pricing_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "product_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "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": {
    "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": []
        }
      }
    ]
  },
  "external_id": "<string>",
  "start_date": "2023-11-07T05:31:56Z",
  "end_date": "2023-11-07T05:31:56Z",
  "anchor_date": "2023-11-07T05:31:56Z",
  "custom_data": {},
  "plan_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "description": "<string>",
  "resolved_description": "<string>",
  "is_optional": false,
  "is_enabled": [
    {
      "value": true,
      "effective_from": "2023-12-25"
    }
  ]
}

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

​
contract_id
string<uuid>
required
​
phase_id
string<uuid>
required

Body

application/json
​
external_id
string | null

External ID

​
start_date
string<date-time> | null

Start Date

​
end_date
string<date-time> | null

End Date

​
anchor_date
string<date-time> | null

Anchor Date

​
pricing_id
string<uuid> | null
default:6cd431e4-d3d4-43dc-b0c4-9c6988a6c1b3

Pricing ID

​
product_id
string<uuid> | null
default:c19a0ece-63c3-412b-8549-e722bc28605d

Product ID

​
custom_data
Custom Data · object

Pricing Association Metadata

​
pricing
CreateProductPricingRequestSchema · object

Pricing for the phase

​
product
Create Product Request V1 · object

Product Name

​
plan_id
string<uuid> | null

Plan ID - reference to the plan_v3 this pricing is associated with

​
description
string | null

Line item description for this pricing association. Overrides pricing and product descriptions if provided.

Response

Successful Response

​
id
string<uuid>
required

Contract Phase Pricing ID

​
phase_id
string<uuid>
required

Contract Phase ID

​
pricing_id
string<uuid>
required

Pricing ID

​
product_id
string<uuid>
required

Product ID

​
created_at
string<date-time>
required

Contract Phase Pricing created at

​
updated_at
string<date-time>
required

Contract Phase Pricing updated at

​
product
ProductResponseSchema · object
required

Product details

​
pricing
ProductBundlePricingResponseSchema · object
required

Pricing details (with overrides applied)

​
external_id
string | null

External ID

​
start_date
string<date-time> | null

Start Date

​
end_date
string<date-time> | null

End Date

​
anchor_date
string<date-time> | null

Anchor Date

​
custom_data
Custom Data · object

Pricing Association Metadata

​
plan_id
string<uuid> | null

Plan ID - reference to the plan_v3 this pricing is associated with

​
description
string | null

Line item description for this pricing association. Overrides pricing and product descriptions if provided.

​
resolved_description
string | null

Effective description resolved from the fallback chain: description > pricing.description > product.description

​
is_optional
boolean
default:false

When True, customers can enable/disable this line item in self-serve checkout

​
is_enabled
EnabledEntry · object[]

Schedule of enable/disable states for this line item over time