Skip to main content

Adding Custom Fields to Existing Plans and Products

Corey Syrnyk
  • Updated

For situations where you had not added the Custom Fields directly into the Products, you can add Custom Fields to your already created Plans and Products, allowing you to store additional metadata that is relevant to your business. This information can be included in custom reports. For information on adding this information to the Products prior to adding the Product to a Plan see Creating Custom Fields at Product Level.

Setting up Custom Fields at Plan and Product level

  1. You must first define your Custom Fields in the Settings area of Stax Bill. If you have not defined your Custom Fields yet, please see the section called Configuring Custom Fields to set them up.
  2. To use Custom Fields at the Plan level, go to Catalog > Plans and choose the plan where the Custom Fields are needed.
  3. Click on Custom Fields.
  4. Using the dropdown for Manage custom fields for, choose the Plan itself or a Product within the current plan where you need custom fields added.
    • Note that if you have multiple frequencies configured, you will need to configure the Custom Fields for each frequency.
    • Custom Fields can be added to the Plan and the Products under that Plan.
    • Note that when you create custom fields on a Product, they will automatically be carried with the Product when the Product is added to a Plan. If the custom field has a default value, this value will also be carried with the Product into the Plan. It can be overridden at that time and/or also at the time a customer subscribes to the Plan. Additional custom fields can also be added to the Product after it is in a Plan.
  5. Select a Custom Field from the dropdown and click Add custom field to plan. The custom field will be added to the list at the bottom.
    • Note that you can only add one of each Custom Field.
    • The key value and the data type are set to the values you configured in the Settings.
  6. If you want your custom field to have a default value when a customer subscribes to this plan, enter the information to the Default Value field and click Update to save the changes.
  7. To remove a custom field from a plan, click Remove.

    Note that only new subscriptions to this plan will reflect the removal of a custom field; all existing subscriptions to the plan will retain the custom field information.

  8. You can repeat these steps to add custom fields to other Products within the Plan, or at the Plan level itself.

Related articles