Metadata

Metadata, or custom data, are sets of name-value pairs, which are used for storing additional, unstructured information on an object. These are pairs of matched text strings that can help categorize or sort aspects of the object. Use Name to define the data, and Value to define the specific input (value) for the definition. The metadata field supports name-value pairs with the following limitations:

The Name parameter in the REST API is limited to 256 characters.
The Name parameter supports any string format, except for the prefix vin: which is used only for system generated metadata.
The Value parameter is limited to 1024 characters.

In some cases, metadata from one object will be automatically inherited by another, which is dependent on it. For example, metadata associated with a Subscription or a SubscriptionItem will be inherited by all Transactions and TransactionItems generated by them.

Example Metadata JSON

{
   "metadata" : {
        "favorite activity" : "flying kites",
        "favorite dog"      : "Snoopy"
    }
}

Parent topic:Resources

Home

Guides

APIs

Example Metadata JSON

​Example Metadata JSON

Example Metadata JSON