plan.yaml fileBeta
The configuration file plans/<PLAN_NAME>/plan.yaml contains the following information:
- General parameters of the <PLAN_NAME> tariff plan.
- The billing section with the cost parameters of the
<PLAN_NAME>tariff plan excluding paid tariff options. - (Optional) The parameters_patch section, which selectively overrides tariff option parameters for the
<PLAN_NAME>plan.
Name | Description | Format | Required |
|---|---|---|---|
| UUID4 tariff plan identifier (ID), generated using a UUID4 generator |
| |
| Tariff plan revision. The combination of the revision and the tariff plan ID determines its uniqueness within the service. The remaining parameters describe the characteristics of a specific tariff plan revision. |
| |
| Technical name of the tariff plan, which is not displayed in the Marketplace interface. Can contain only Latin letters and the |
| |
| Name of the tariff plan, which is displayed in the Marketplace interface |
| |
| Determines whether the tariff plan is free |
| |
| The billing section of the tariff plan, determines the cost of the tariff plan excluding paid tariff options | ||
| The parameters_patch section, selectively overrides tariff option parameters for a specific plan | ||
| List of postpaid tariff options. | Array | Yes — for a plan with postpaid options |
Section parameters:
Name | Description | Format | Required | Default value |
|---|---|---|---|---|
| Cost of the tariff plan for the billing period, excluding paid tariff options. Specified in the currency of the country where Marketplace is deployed. For a free tariff plan — |
| — | |
| Determines whether funds are refunded to the project's bonus account for the remaining days of the billing period if the user changed the tariff plan or deleted the service instance. The parameter affects the date the payment for the service is charged when the user changes the tariff plan (edits the tariff options or switches to a new one):
|
|
| |
| Duration of the billing period for the billing. Record format: |
|
|
Example of filling in the billing section:
billing:cost: 2000refundable: truebilling_cycle_flat: 1 mons 0 days
The following shows how the cost of the tariff plan from this example is displayed in the tariff plan configuration wizard.
This section selectively overrides tariff option parameters for the tariff plan: individual parameters or entire sections of the tariff option description.
For each parameter being overridden, its name is specified with the path to the root section. The parameter name and the names of its parent sections are separated by dots.
Example of overriding tariff option parameters:
parameters_patch:users:schema.const: 5000volume_data_size:schema.default: 550schema.minimum: 550
In this example, new values are assigned to:
- the
costparameter in theschemasection of theuserstariff option; - the
defaultandminimumparameters in theschemasection of thevolume_data_sizetariff option.
The possible parameters, depending on the type of tariff option, are provided in the Tariff option YAML file section.
The parameter values specified in the parameters_patch section take precedence over the values from the tariff option YAML files.
If the tariff plans use options that differ significantly from each other:
- It is recommended to describe each option in a separate YAML file in the
parametersdirectory. - It is not recommended to describe a single tariff option for all tariff plans and override most of its parameters in different tariff plans.
Example of a tariff plan with overridden tariff option parameters:
id: b2b42648-XXXX-b4cddbf010b2revision: v. 1.0name: basicdescription: Basicfree: falsebilling:cost: 2000refundable: truebilling_cycle_flat: 1 monsparameters_patch:users:schema.const: 5000volume_data_size:schema.default: 550schema.minimum: 550
Example of a free tariff plan with a postpaid tariff option:
id: 3aa541d8-XXXX-6dbf542b3f90revision: v. 1.1name: postpaiddescription: Postpaidfree: truebilling:cost: 0resource_usages:- storage