Skip to main content
GET
/
billing
/
org
/
v1
/
addendums
List Addendums
curl --request GET \
  --url https://api.gcore.com/billing/org/v1/addendums \
  --header 'Authorization: <api-key>'
{
  "count": 123,
  "next": "http://api.example.org/accounts/?offset=400&limit=100",
  "previous": "http://api.example.org/accounts/?offset=200&limit=100",
  "results": [
    {
      "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

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.

​
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

​
id
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.

​
ordering
enum<string>[]

Ordering of the results.

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.

  • 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)
​
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

​
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:

  • AWS_CLOUD - AWS Cloud

  • CDN - CDN

  • CLOUD - Cloud

  • CONNECT - Colocation Services

  • CONNECTIVITY - Connectivity

  • DDOS - Web Security

  • DNS - Managed DNS

  • FAST_EDGE - FastEdge

  • 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

  • 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.

​
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

Response

200 - application/json
​
count
integer
required
Example:

123

​
results
object[]
required
​
next
string<uri> | null
Example:

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

​
previous
string<uri> | null
Example:

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