The main objects in the server API have a metadata
object field that you can use to store any data you like as key-value pairs. For example, you could store your own internal ID values here to help with order tracking.
There are 2 reserved keys in the metadata
object that you should not use for your own data:
- taxes_amount is zero or a positive number representing the taxes included in the
amount
- shipping_amount is a zero or a positive number representing the shipping costs included in the
amount
Note that the metadata
object has the following restrictions (which cannot be reconfigured):
- A maximum of 50 key-value pairs per object
- Keys must be no more than 40 characters in length
- Values must be no more than 500 characters in length