v32

latestOpenAPI 3.1.0raw.githubusercontent.com2026-05-151,1412,2144.5 MB
addendums

Get a single Addendum

Retrieve a single Addendum by ID.

get/billing/org/v1/addendums/{id}

Path parameters

idinteger required

Response

Request successful.

idinteger required
client_idinteger required

The ID of the client associated with the addendum.

status'upcoming' | 'active' | 'paused' | 'stopped' required

Addendum status

  • upcoming - upcoming
  • active - active
  • paused - paused
  • stopped - stopped
created_atstring date-time required

Date of current addendum creation

status_at_active_atstring nullable required

Status of the addendum at the requested active_at time.

This field is not present by default, but it can be requested by passing the active_at query parameter.