Sign in

v1

latestOpenAPI 3.1.0AGPLv32026-07-26168262527.5 KB
credit_notes

Replace credit note metadata

This endpoint replaces all existing metadata on a credit note with the provided key-value pairs. Any existing metadata keys not included in the request will be removed.

post/credit_notes/{lago_id}/metadata

Path parameters

lago_idstring uuid required
Example:1f615414-ceb0-11f0-94bf-0f2d5b311aba

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 replaced

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
  }
}