Docs

Log in to read the version of docs relevant to your site, or use the dropdown versions

Metadata

If you want to store additional/custom data at a resource's level, you can make use of Chargebee's Metadata.

For example, if you are a data service provider and want to store additional information of a particular plan, you can store it in the Metadata of the Plan.

Metadata can be passed during the Add/Update operations, for the following entities:

Metadata can be stored only in the JSON format. You can use nested JSON objects as well.

Note

  • Metadata is completely for your reference and will not be 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 will not be a filter criteria, or a part of the exports. For this purpose, use Custom Fields if necessary.
  • Copy Configurations option in your Chargebee TEST site does not copy the Metadata saved in your TEST site to your LIVE site

See also

Articles & FAQs

Is metadata supported for both items and item price points? How it is affected during the migration?
What is Meta Data?

Was this article helpful?