v1

latestOpenAPI 3.1.0AGPLv32026-07-26168262527.5 KB

credit_notes

Merge credit note metadata

This endpoint merges the provided metadata with existing metadata on the credit note. Existing keys not in the request are preserved. New keys are added, existing keys are updated.

patch/credit_notes/{lago_id}/metadata

Path parameters

lago_idstring uuid required

Example:1a901a90-1a90-1a90-1a90-1a901a901a90

The credit note unique identifier, created by Lago.

Request body

metadataMetadataObject nullable required

Custom metadata stored as key-value pairs. Keys are strings (max 100 characters), values can be strings (max 255 characters) or null.

Example request

{
  "metadata": {
    "external_id": "ext-123",
    "synced_at": "2024-01-15",
    "source": null
  }
}

Response

Credit note metadata merged

metadataMetadataObject nullable required

Custom metadata stored as key-value pairs. Keys are strings (max 100 characters), values can be strings (max 255 characters) or null.

Example response

{
  "metadata": {
    "external_id": "ext-123",
    "synced_at": "2024-01-15",
    "source": null
  }
}