GET
/
billing
/
v1
/
org
/
addendums
Get addendums
curl --request GET \
  --url https://api.gcore.com/billing/v1/org/addendums \
  --header 'Authorization: <api-key>'
{
  "count": 123,
  "next": "https://api.gcore.com/billing/v1/org/addendums?offset=20&limit=10",
  "previous": "https://api.gcore.com/billing/v1/org/addendums?offset=20&limit=10",
  "results": [
    {
      "id": 123,
      "client_id": 123,
      "plan_id": 123,
      "status": "upcoming",
      "active_from": "2023-11-07T05:31:56Z",
      "active_to": "2023-11-07T05:31:56Z",
      "created_at": "2023-11-07T05:31:56Z",
      "previous_id": 123,
      "plan_name_en": "<string>",
      "plan_currency_char_code": "<string>",
      "plan_currency_id": 123,
      "product_id": "<string>",
      "product_internal_name": "<string>",
      "archived": true,
      "description": "<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

Query Parameters

​
id
integer

Specify ID of the requested addendum

​
plan_id
integer

Specify ID of a plan

​
status
enum<string>

Status of addendum

Available options:
active,
upcoming,
paused,
stopped
​
active_at
string<date-time>

Filter addendums that were active at this specific time. Format: ISO 8601 (e.g., 2024-05-30T12:00:00Z).

​
active_from
string<date-time>

Specify the exact start date of the addendums activation period (ISO 8601/RFC 3339 format, UTC.) You can specify a date with a time separated by a space, or just a date. Examples:

  • &active_from=2021-05-05 12:00:00
  • &active_from=2021-05-05
​
created_at
string<date-time>

Specifies the exact date when the addendums were created, (ISO 8601/RFC 3339 format, UTC.) You can specify a date with a time separated by a space, or just a date. Examples:

  • &created_at=2021-05-05 12:00:00
  • &created_at=2021-05-05
​
active_from__from
string<date-time>

Specify the start date range for the addendums activation period (ISO 8601/RFC 3339 format, UTC.) You can specify a date with a time separated by a space, or just a date. Examples:

  • &active_from__from=2021-05-05 12:00:00
  • &active_from__from=2021-05-05
​
active_from__to
string<date-time>

Specify the end date range for the addendums activation period(ISO 8601/RFC 3339 format, UTC.) You can specify a date with a time separated by a space, or just a date. Examples:

  • &active_from__to=2021-05-05 12:00:00
  • &active_from__to=2021-05-05
​
active_to
string<date-time>

Specify the exact end date of the addendum active period (ISO 8601/RFC 3339 format, UTC.) You can specify a date with a time separated by a space, or just a date. Examples:

  • &active_to=2021-05-05 12:00:00
  • &active_to=2021-05-05
​
active_to__from
string<date-time>

Specify the start of the date range for the addendum end period (ISO 8601/RFC 3339 format, UTC.) You can specify a date with a time separated by a space, or just a date. Examples:

  • &active_to__from=2021-05-05 12:00:00
  • &active_to__from=2021-05-05
​
active_to__to
string<date-time>

Specify the end of the date range for the addendum end period (ISO 8601/RFC 3339 format, UTC.) You can specify a date with a time separated by a space, or just a date. Examples:

  • &active_to__to=2021-05-05 12:00:00
  • &active_to__to=2021-05-05
​
created_at__from
string<date-time>

Specifies the start of the date range when the addendums were created (ISO 8601/RFC 3339 format, UTC.). You can specify a date with a time separated by a space, or just a date. Examples:

  • &created_at__from=2021-05-05 12:00:00
  • &created_at__from=2021-05-05
​
created_at__to
string<date-time>

Specifies the end of the date range when the addendums were created (ISO 8601/RFC 3339 format, UTC.). You can specify a date with a time separated by a space, or just a date. Examples:

  • &created_at__to=2021-05-05 12:00:00
  • &created_at__to=2021-05-05
​
client_id
integer

ID of the client who has addendum(addendums).

​
product_id
integer

Specify product ID. Possible values:

IDNameInternal Name
1CDNCDN
2Object StorageSTORAGE
3Web SecurityDDOS
4StreamingSTREAMING
5CloudCLOUD
6Colocation ServicesCONNECT
9DDoS ProtectionINFRASTRUCTURE_PROTECTION
10Managed DNSDNS
11Other ServicesOTHER_SERVICES
12Premium SupportPREMIUM_SUPPORT
13ConnectivityCONNECTIVITY
14Hosting (G-Hosting)GHOST
15Managed ServicesMANAGED_SERVICES
16RentRENT
17Software developmentSOFTWARE_DEVELOPMENT
18VM WareVMWARE
19LaaSLAAS
20AWS CloudAWS_CLOUD
21Fast EdgeFAST_EDGE
22Technical SupportTECHNICAL_SUPPORT
​
product_internal_name
enum<string>

Specify a product's internal name. Possible values:

IDNameInternal Name
1CDNCDN
2Object StorageSTORAGE
3Web SecurityDDOS
4StreamingSTREAMING
5CloudCLOUD
6Colocation ServicesCONNECT
9DDoS ProtectionINFRASTRUCTURE_PROTECTION
10Managed DNSDNS
11Other ServicesOTHER_SERVICES
12Premium SupportPREMIUM_SUPPORT
13ConnectivityCONNECTIVITY
14Hosting (G-Hosting)GHOST
15Managed ServicesMANAGED_SERVICES
16RentRENT
17Software developmentSOFTWARE_DEVELOPMENT
18VM WareVMWARE
19LaaSLAAS
20AWS CloudAWS_CLOUD
21Fast EdgeFAST_EDGE
22Technical SupportTECHNICAL_SUPPORT
Available options:
CDN,
STORAGE,
DDOS,
STREAMING,
CLOUD,
CONNECT,
INFRASTRUCTURE_PROTECTION,
DNS,
OTHER_SERVICES,
PREMIUM_SUPPORT,
CONNECTIVITY,
GHOST,
MANAGED_SERVICES,
RENT,
SOFTWARE_DEVELOPMENT,
VMWARE,
LAAS,
AWS_CLOUD,
FAST_EDGE,
TECHNICAL_SUPPORT
​
plan_name
string

Specify a plan name.

​
client_company
string

A name of the client's company (or client's name).

​
plan_currency_char_code
enum<string>

Specify code for plan currency. Possible values:

  • EUR - for EUR
  • USD - for USD
Available options:
EUR,
USD
​
ordering
enum<string>

Ordering

Available options:
id,
-id,
status,
-status,
active_from,
-active_from,
active_to,
-active_to,
created_at,
-created_at
​
limit
integer

Maximum number of items in response.

​
offset
integer

The initial index from which to return the results.

Response

200 - application/json

OK

The response is of type object.