Udpate 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

Merge credit note metadata

cURL

curl --request PATCH \
  --url https://api.getlago.com/api/v1/credit_notes/{lago_id}/metadata \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "metadata": {
    "external_id": "ext-123",
    "synced_at": "2024-01-15",
    "source": null
  }
}
'

200

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

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

lago_id · string<uuid> · required

The credit note unique identifier, created by Lago.

Example:

"1a901a90-1a90-1a90-1a90-1a901a901a90"

Body

application/json

metadata · object · required

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

Show child attributes

Example:

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

Response

200

application/json

Credit note metadata merged

metadata · object · required

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

Show child attributes

Example:

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