Skip to main content
GET
/
billing
/
org
/
v1
/
addendums
/
{id}
Get a single Addendum
curl --request GET \
  --url https://api.gcore.com/billing/org/v1/addendums/{id} \
  --header 'Authorization: <api-key>'
{
  "id": 123,
  "client_id": 123,
  "client": {
    "id": 123,
    "company_name": "<string>"
  },
  "status": "upcoming",
  "active_range": {
    "start": "2023-11-07T05:31:56Z",
    "end": "2023-11-07T05:31:56Z"
  },
  "created_at": "2023-11-07T05:31:56Z",
  "currency": {
    "id": 123,
    "char_code": "<string>",
    "symbol": "<string>"
  },
  "plan": {
    "id": 123,
    "name": "<string>"
  },
  "product": {
    "id": 123,
    "name": "<string>",
    "internal_name": "<string>"
  },
  "status_at_active_at": "<string>"
}

Authorizations

​
Authorization
string
header
required

API key for authentication. Make sure to include the word apikey, followed by a single space and then your token. Example: apikey 1234$abcdef

Path Parameters

​
id
integer
required

Response

200 - application/json
​
id
integer
required
​
client_id
integer
required

The ID of the client associated with the addendum.

​
client
object
required

The client associated with the addendum.

​
status
enum<string>
required

Addendum status

* upcoming - upcoming * active - active * paused - paused * stopped - stopped

Available options:
upcoming,
active,
paused,
stopped
​
active_range
object
required

The time range during which the addendum is active. Date-time range with start and end fields.

​
created_at
string<date-time>
required

Date of current addendum creation

​
currency
object
required

The currency used in the addendum.

​
plan
object
required

The plan associated with the addendum.

​
product
object
required

The product associated with the addendum.

​
status_at_active_at
string | null
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.

⌘I