v1

latestOpenAPI 3.1.0AGPLv32026-07-26168262527.5 KB
credit_notes

Delete a metadata key

This endpoint removes a single metadata key from a credit note.

delete/credit_notes/{lago_id}/metadata/{key}

Path parameters

lago_idstring uuid required
Example:1a901a90-1a90-1a90-1a90-1a901a901a90

The credit note unique identifier, created by Lago.

keystring required
Example:external_id

The metadata key to delete.

Response

Metadata key deleted

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