credit_notes

Delete a metadata key

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

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

Request

Base URL
https://api.getlago.com/api/v1
Auth
HTTP bearer
TypeScript
https://skmtc.dev/getlago/apis/lago-api-documentation/docs/credit_notes/:lago_id/metadata/:key/delete.ts
A function with typed inputs. Its response is checked against the schema.

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.

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.

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

No recorded changes to this operation across all 3 revisions of this API.