Metadata on customer is useful for storing additional structured information on an object to provide more context.
For example, you could store a customer’s full name and unique identifier from your system on a Customer object by defining a key-value pair. A key cannot exist without its corresponding value, and vice versa.
After adding metadata to a customer, you can edit or delete it. To edit metadata, you have two options:
When editing customer metadata through the API, make sure to include the existing metadata in your payload to avoid removing them.
Similarly, you can delete a key-value metadata pair by:
To display customer metadata on invoices, you can switch on the option in the customer creation/edition drawer or set display_in_invoice
to true. Once this option is activated, metadata will be displayed on all new finalized and downloaded invoices.
When the customer’s metadata is added/edited/removed, the change only applies to new PDF files. Existing documents are not affected.
Metadata on customer is useful for storing additional structured information on an object to provide more context.
For example, you could store a customer’s full name and unique identifier from your system on a Customer object by defining a key-value pair. A key cannot exist without its corresponding value, and vice versa.
After adding metadata to a customer, you can edit or delete it. To edit metadata, you have two options:
When editing customer metadata through the API, make sure to include the existing metadata in your payload to avoid removing them.
Similarly, you can delete a key-value metadata pair by:
To display customer metadata on invoices, you can switch on the option in the customer creation/edition drawer or set display_in_invoice
to true. Once this option is activated, metadata will be displayed on all new finalized and downloaded invoices.
When the customer’s metadata is added/edited/removed, the change only applies to new PDF files. Existing documents are not affected.