Metadata is present on every resource on the Hyper API. You can use this parameter to attach key-value data to these Stripe objects. Metadata is useful for storing additional, structured information on an object.

You can store any key-value pair of strings in metadata. To set a value, PATCH to the resource, with the updated key and value in metadata in the JSON body. These values must be stored as strings. If you require a specific type, this casting must be done in your client.

{
  "metadata": {
    "key": "value"
  }
}

To unset a key value, you must pass the key to be reset with a null value as a JSON body.

{
  "metadata": {
    "key": null
  }
}