options.yaml

Options are parts of a subscription plan. Each option has a unique text id used as key.

Each option is merged with defaults.option configured in defaults.yaml. The properties of the option override the defaults.

Sections & properties

quantity

Quantity of the option

quantity: 1

description

Public description for the option

description:
    fr: titre
    en: title

note

Private comment for the option

note: |
   this text will be displayed in the backoffice.
   and can be a full description...

price-period

Defines the duration of the price, in month (m), in days (d) or even year (y)

price-period: 1m

price

Price in each currency you have defined in config.yaml

price:
    eur: 999999
    usd: 999999

prorated

Set false if the option price should not be prorated if added in the plan during the period.

prorated: false

taxes

Lists of the taxes that will be applied on this option. Each tax can be overload locally in the option.

taxes:
    "tax-id":

permissions

Lists of the permissions unlocked by this option in your SAAS service.

permissions: [perm-A, perm-B, etc]

service-values

In this section you can add everything you want. It'll not be used for the billing, but you'll be able to access this data though the API.

service-values:
    "specific1":
        "iwant": true
        "isay": "why not"
    "specific2":
        etc: ...

counters

Counter that will be impacted by this option. You can add properties that override, or complete the options defined in the counter.

counter:
    "counter1":
        value: 999

editable

Defines which value can be overwritten when the plan is created or an option is added.

editable: [quantity, description, price] #key name

Example

options:
    "young-subs":
        description:
            fr: Abonnement YOUNG
            en: YOUNG Subscription
        note: Comprend dans son prix un ensemble d'options qui doivent être incluses dans le plan
        price:
            eur: 250
            usd: 300
        price-period: 1m
        permissions: [basic]