List Addendums

curl --request GET \
  --url https://api.gcore.com/billing/org/v1/addendums \
  --header 'Authorization: <api-key>'

import requests

url = "https://api.gcore.com/billing/org/v1/addendums"

headers = {"Authorization": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: '<api-key>'}};

fetch('https://api.gcore.com/billing/org/v1/addendums', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.gcore.com/billing/org/v1/addendums",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.gcore.com/billing/org/v1/addendums"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.gcore.com/billing/org/v1/addendums")
  .header("Authorization", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.gcore.com/billing/org/v1/addendums")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "count": 123,
  "results": [
    {
      "id": 123,
      "client_id": 123,
      "client": {
        "id": 123,
        "company_name": "<string>"
      },
      "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>"
    }
  ],
  "next": "http://api.example.org/accounts/?offset=400&limit=100",
  "previous": "http://api.example.org/accounts/?offset=200&limit=100"
}

GET

billing

org

addendums

List Addendums

curl --request GET \
  --url https://api.gcore.com/billing/org/v1/addendums \
  --header 'Authorization: <api-key>'

import requests

url = "https://api.gcore.com/billing/org/v1/addendums"

headers = {"Authorization": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: '<api-key>'}};

fetch('https://api.gcore.com/billing/org/v1/addendums', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.gcore.com/billing/org/v1/addendums",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.gcore.com/billing/org/v1/addendums"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.gcore.com/billing/org/v1/addendums")
  .header("Authorization", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.gcore.com/billing/org/v1/addendums")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "count": 123,
  "results": [
    {
      "id": 123,
      "client_id": 123,
      "client": {
        "id": 123,
        "company_name": "<string>"
      },
      "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>"
    }
  ],
  "next": "http://api.example.org/accounts/?offset=400&limit=100",
  "previous": "http://api.example.org/accounts/?offset=200&limit=100"
}

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

active_after

string<date-time>

Filter by active period.

Returns items active after the specified date-time (ISO 8601/RFC 3339 format, UTC.)

You can specify a date with a time separated by a space, or just a date.

Examples:

&active_after=2025-05-15 12:00:00
&active_after=2025-05-15T12:00:00Z

active_at

string<date-time>

Filter by active period.

Returns items active at the specified date-time (ISO 8601/RFC 3339 format, UTC.)

You can specify a date with a time separated by a space.

Examples:

&active_at=2025-05-15 12:00:00
&active_at=2025-05-15T12:00:00Z

active_before

string<date-time>

Filter by active period.

Returns items active before the specified date-time (ISO 8601/RFC 3339 format, UTC.)

You can specify a date with a time separated by a space, or just a date.

Examples:

&active_before=2025-05-15 12:00:00
&active_before=2025-05-15T12:00:00Z

active_end_from

string<date-time>

Filter by active period.

Returns items with the end of the active period on or after the specified date-time (ISO 8601/RFC 3339 format, UTC.)

You can specify a date with a time separated by a space.

Examples:

&active_end_from=2025-05-15 12:00:00
&active_end_from=2025-05-15T12:00:00Z

active_end_to

string<date-time>

Filter by active period.

Returns items with the end of the active period on or before the specified date-time (ISO 8601/RFC 3339 format, UTC.)

You can specify a date with a time separated by a space.

Examples:

&active_end_to=2025-05-15 12:00:00
&active_end_to=2025-05-15T12:00:00Z

active_start_from

string<date-time>

Filter by active period.

Returns items with the start of the active period on or after the specified date-time (ISO 8601/RFC 3339 format, UTC.)

You can specify a date with a time separated by a space.

Examples:

&active_start_from=2025-05-15 12:00:00
&active_start_from=2025-05-15T12:00:00Z

active_start_to

string<date-time>

Filter by active period.

Returns items with the start of the active period on or before the specified date-time (ISO 8601/RFC 3339 format, UTC.)

You can specify a date with a time separated by a space.

Examples:

&active_start_to=2025-05-15 12:00:00
&active_start_to=2025-05-15T12:00:00Z

addendum_id

integer[]

Filter by Addendum ID. Can be multiple.

client_id

integer[]

Filter by client ID. Can be multiple.

Required range: -2147483648 <= x <= 2147483647

company_name

string

Filter by client's company name (client's name). Case insensitive. Supports partial matches.

created_after

string<date-time>

Filter by creation date-time.

Returns items created after the specified date-time (ISO 8601/RFC 3339 format, UTC.)

You can specify a date with a time separated by a space, or just a date.

Examples:

&created_after=2025-05-15
&created_after=2025-05-15 12:00:00
&created_after=2025-05-15T12:00:00Z

created_before

string<date-time>

Filter by creation date-time.

Returns items created before the specified date-time (ISO 8601/RFC 3339 format, UTC.)

You can specify a date with a time separated by a space, or just a date.

Examples:

&created_before=2025-05-15
&created_before=2025-05-15 12:00:00
&created_before=2025-05-15T12:00:00Z

created_on

string<date>

currency_char_code

string[]

Filter by currency char code (e.g. USD, EUR). Can be multiple.

Returns currencies with the specified char code.

Examples:

&currency_char_code=USD
&currency_char_codeEUR&currency_char_codeUSD

Available values:

EUR - Euro
USD - US Dollar

currency_id

integer[]

Filter by currency ID. Can be multiple.

Returns currencies with the specified ID.

Examples:

&currency_id=1
&currency_id=1&currency_id=2

Available values:

1 - US Dollar
2 - Euro

integer

limit

integer

Number of results to return per page. Maximum is 100.

not_active_at

string<date-time>

Filter by active period.

Returns items not active at the specified date-time (ISO 8601/RFC 3339 format, UTC.)

You can specify a date with a time separated by a space.

Examples:

&not_active_at=2025-05-15 12:00:00
&not_active_at=2025-05-15T12:00:00Z

offset

integer

The initial index from which to return the results.

order_by

enum<string>[]

Ordering of the results.

For ascending sort order use field.asc, for descending sort order use field.desc.

For sorting by multiple parameters write them as comma separated string: client_id.asc,id.desc.

Final stable tiebreak ordering by primary key is added except when queryset DISTINCT ON is used or pk sorting used.

created_at.asc - Created at
created_at.desc - Created at (descending)
active_range_start.asc - Active range start
active_range_start.desc - Active range start (descending)
active_range_end.asc - Active range end
active_range_end.desc - Active range end (descending)
id.asc - Id
id.desc - Id (descending)
client_id.asc - Client id
client_id.desc - Client id (descending)
plan_name.asc - Plan name
plan_name.desc - Plan name (descending)
plan_id.asc - Plan id
plan_id.desc - Plan id (descending)
product_name.asc - Product name
product_name.desc - Product name (descending)
product_id.asc - Product id
product_id.desc - Product id (descending)

Available options:

active_range_end.asc,

active_range_end.desc,

active_range_start.asc,

active_range_start.desc,

client_id.asc,

client_id.desc,

created_at.asc,

created_at.desc,

id.asc,

id.desc,

plan_id.asc,

plan_id.desc,

plan_name.asc,

plan_name.desc,

product_id.asc,

product_id.desc,

product_name.asc,

product_name.desc

ordering

enum<string>[]

Ordering of the results.

This field is left for compatibility and can be deprecated in future versions. Use order_by instead.

Default sort order is ascending. Put - before value for descending sort order: -id.

For sorting by multiple parameters write them as comma separated string: -client_id,id.

Final stable tiebreak ordering by primary key is added except when queryset DISTINCT ON is used or pk sorting used.

created_at - Created at
-created_at - Created at (descending)
active_range_start - Active range start
-active_range_start - Active range start (descending)
active_range_end - Active range end
-active_range_end - Active range end (descending)
id - Id
-id - Id (descending)
client_id - Client id
-client_id - Client id (descending)
plan_name - Plan name
-plan_name - Plan name (descending)
plan_id - Plan id
-plan_id - Plan id (descending)
product_name - Product name
-product_name - Product name (descending)
product_id - Product id
-product_id - Product id (descending)

Available options:

-active_range_end,

-active_range_start,

-client_id,

-created_at,

-id,

-plan_id,

-plan_name,

-product_id,

-product_name,

active_range_end,

active_range_start,

client_id,

created_at,

id,

plan_id,

plan_name,

product_id,

product_name

payer_id

(integer | null)[]

Filter by payer ID. Can be multiple.

plan_id

integer[]

Filter by plan ID. Can be multiple.

plan_name

string

Filter by plan name. Case insensitive. Supports partial matches.

product_id

integer[]

Filter by product ID. Can be multiple.

Returns products with the specified ID.

Examples:

&product_id=1
&product_id=1&product_id=2

Available values:

1 - CDN
2 - Object Storage
3 - Web Security
4 - Streaming
5 - Cloud
6 - Colocation Services
7 - WG Private Cloud
8 - p2p
9 - DDoS Protection
10 - Managed DNS
11 - Other Services
12 - Premium Support
13 - Connectivity
14 - Hosting (G-Hosting)
15 - Managed Services
16 - Rent
17 - Software development
18 - VM Ware
19 - LaaS
20 - AWS Cloud
21 - FastEdge
22 - Technical Support
23 - WAAP
25 - Edge Proxy
32 - AI Managed Dedicated Compute
65 - Gclaw

product_internal_name

string[]

Filter by product internal name. Can be multiple.

Returns products with the specified internal name.

Examples:

&product_internal_name=CDN
&product_internal_name=CDN&product_internal_name=DNS

Available values:

AI_DEDCOMP - AI Managed Dedicated Compute
AWS_CLOUD - AWS Cloud
CDN - CDN
CLOUD - Cloud
CONNECT - Colocation Services
CONNECTIVITY - Connectivity
DDOS - Web Security
DNS - Managed DNS
FAST_EDGE - FastEdge
GCLAW - Gclaw
GHOST - Hosting (G-Hosting)
INFRASTRUCTURE_PROTECTION - DDoS Protection
LAAS - LaaS
MANAGED_SERVICES - Managed Services
OTHER_SERVICES - Other Services
P2P - p2p
PREMIUM_SUPPORT - Premium Support
RENT - Rent
SHIELD_PROXY - Edge Proxy
SOFTWARE_DEVELOPMENT - Software development
STORAGE - Object Storage
STREAMING - Streaming
TECHNICAL_SUPPORT - Technical Support
VMWARE - VM Ware
WAAP - WAAP
WG_PRIVATE_CLOUD - WG Private Cloud

product_name

string

Filter by product name. Case insensitive. Supports partial matches.

provider_id

integer[]

Filter by provider ID. Can be multiple.

Required range: -2147483648 <= x <= 2147483647

reseller_id

integer

Filter by reseller ID. Can be multiple.

status

enum<string>[]

Filter by addendum statuses. Can be multiple.

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

Available options:

active,

paused,

stopped,

upcoming

Response

Request successful.

count

integer

required

Example:

123

results

object[]

required

Show child attributes

string<uri> | null

Example:

"http://api.example.org/accounts/?offset=400&limit=100"

string<uri> | null

Example:

"http://api.example.org/accounts/?offset=200&limit=100"

Update SFTP storage Get a single Addendum

⌘I

Overview

IAM

CDN

Managed DNS

Cloud

DDoS Protection

FastEdge

WAAP

Streaming

Object Storage

Resellers

List Addendums

Authorizations

Query Parameters

Response