Metafields

Metafields allow you to add additional attributes to certain Recharge API resources.

Metafields provide flexibility by enabling you to tailor data storage to your specific needs without modifying the core structure of the system.


Understanding metafields

Metafields allow you to add additional attributes to certain Recharge API resources. Use them to store extra information. For example, integrating Recharge with a connector app to pass store data to an ERP.

The following resources support Metafields:

  • Stores
  • Customers
  • Subscriptions
  • Orders
  • Charges

🚧

Note:

There is a limit of 50 metafields per owner_id.

When making a GET to retrieve a list of /metafields/, you must specify the owner_resource as a query string. For example:

https://api.rechargeapps.com/metafields?owner_resource=customer

The following table details which scopes are required to write the metafields

ScopeDescription
write_*RESOURCE**RESOURCE* should be the API resource for which you're creating the metafield.


Need Help? Contact Us