Metadata

Rules

• Up to 50 keys. Keys up to 40 characters, without [ or ]. Values are strings up to 500 characters.
• A checkout session's metadata is copied to the invoice it creates.
• Metadata is returned on the invoice and included in every webhook event for it.
• Filter lists with metadata[orderId]=1048. Repeat for several keys; all must match.
• Do not store secrets or customer personal data in metadata.

Update

PATCH /invoices/:id merges keys. A null value deletes that key; keys you omit are unchanged.

const response = await fetch(`${process.env.BOSPAY_API_BASE}/invoices/inv_1048`, {
  method: "PATCH",
  headers: {
    "Content-Type": "application/json",
    "BOSPay-Version": "2026-09-23",
    "X-API-Key": process.env.BOSPAY_API_KEY,
  },
  body: JSON.stringify({
    "metadata": {
      "fulfilment": "shipped",
      "note": null
    }
  })
});
if (!response.ok) {
  throw new Error(`BOSPay request failed: ${response.status}`);
}
const data = await response.json();