Metadata
If you want to store additional or custom data at a resource's level, you can use Chargebee's Metadata.
For example, if you are a data service provider and want to store extra information about a particular plan, you can store it in the plan's Metadata.
Metadata can be passed during the Add/Update operations, for the following entities:
- Subscriptions
- Customers
- Plans
- Plan Price Points
- Addons
- Addon Price Points
- Charges
- Charge Price Points
- Coupons
Metadata can be stored only in the JSON format. You can use nested JSON objects as well.
- Metadata is for your reference and is not visible to customers. If you'd like to include fields in the hosted pages, invoices, and customer portal, other than the default fields, use Custom Fields.
- Metadata is not a filter criterion, and it is not part of exports. For this purpose, use Custom Fields if necessary.
- The Copy Configurations option in your Chargebee TEST site does not copy the metadata saved in your TEST site to your LIVE site.
See also