Metadata

In order to make your integration easier, we provide you with a way to include your own metadata to some of our entities. This means that you can add attach additional pieces of information, such as your internal IDs.

You can add your own metadata by sending key-value pair as a JSON object.

For example:

{
  "metadata": {
    "my_own_internal_id": "1234",
    "my_own_status": "pending-review"
  }
}

Important limitations

Please note that there are some limits to how you can use this field.

• It must be a flat, key-value pair object (complex structures will be removed)
• Both keys and values must be strings (anything else will be casted to a string)
• You can store up to 10 key-value pairs
• The metadata field is supported in the following entities: User, Invoice, Product, Subscription.