Update metadata

The Update metadata request will replace the current metadata.

Important

This operation is only available while the purchase is still in progress.

The metadata can be updated by calling the Checkout API from your backend:

PUT /checkouts/{checkoutId}/metadata

API Reference

See Update metadata for the request schema, examples and error reasons.

Metadata body

Each key in the object must be a string but the value can be any valid JSON value. Key casing is preserved. Providing an empty body will remove any existing metadata.

Error responses

The error reasons this endpoint can return are listed per status code in the API Reference. The Error codes page explains the HTTP status codes used across the Checkout API.