Skip to main content
POST
/
plans
/
{plan_id}
/
phases
Create plan phase
curl --request POST \
  --url https://api.zenskar.com/plans/{plan_id}/phases \
  --header 'Content-Type: application/json' \
  --header 'organisation: <api-key>' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "name": "<string>",
  "schedule": {
    "duration": "<string>",
    "start_offset": "P0D",
    "trigger_type": "time_based"
  },
  "order": 123,
  "description": "<string>",
  "features": {
    "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>"
      }
    ]
  },
  "pricings": [
    {
      "schedule": {
        "duration": "<string>",
        "start_offset": "P0D",
        "trigger_type": "time_based"
      },
      "pricing_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "product_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "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": {}
      }
    }
  ]
}
'
{
  "name": "<string>",
  "schedule": {
    "duration": "<string>",
    "start_offset": "P0D",
    "trigger_type": "time_based"
  },
  "order": 123,
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "plan_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "description": "<string>",
  "pricings": [],
  "features": {
    "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

​
plan_id
string<uuid>
required

Body

application/json
​
name
string
required

Plan name

​
schedule
Schedule · object
required

Schedule of the Phase

​
order
integer
required

Order of the phase

​
description
string | null

Product Description

​
features
CreateProductPricingRequestSchema · object

Phase Features

​
pricings
CreatePlanPhasePricingRequestSchema · object[] | null

Different Product Pricings

Response

Successful Response

​
name
string
required

Plan name

​
schedule
Schedule · object
required

Schedule of the phase

​
order
integer
required

Order of the phase

​
id
string<uuid>
required

Plan ID

​
created_at
string<date-time>
required

Plan created at

​
updated_at
string<date-time>
required

Plan updated at

​
plan_id
string<uuid>
required

Plan ID

​
description
string | null

Product Description

​
pricings
PlanPhasePricingResponseSchema · object[] | null

Different Product Pricings

​
features
ProductPricingResponseSchema · object

Phase Features