Skip to main content
PATCH
/
credit_notes
/
{lago_id}
/
metadata
Merge credit note metadata
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
  }
}
'
{
  "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 for the credit note, stored as key-value pairs. Keys are strings (max 40 characters), values can be strings (max 255 characters) or null.

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

Response

Credit note metadata merged

​
metadata
object
required

Custom metadata for the credit note, stored as key-value pairs. Keys are strings (max 40 characters), values can be strings (max 255 characters) or null.

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