Skip to main content
GET
/
billing
/
org
/
v1
/
plans
/
contents
List PlanContents
curl --request GET \
  --url https://api.gcore.com/billing/org/v1/plans/contents \
  --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,
      "plan_id": 123,
      "default": true,
      "feature": {
        "id": 123,
        "name": "<string>",
        "erp_sku_id": "<string>"
      },
      "metric_ext_name": "<string>",
      "regions": [
        {
          "id": 123,
          "name": "<string>",
          "external_name": "<string>"
        }
      ],
      "product_category": {
        "id": 123,
        "name": "<string>"
      },
      "product": {
        "id": 123,
        "name": "<string>",
        "internal_name": "<string>"
      },
      "calc_rule_type": "<string>",
      "unit": {
        "id": 2,
        "name": "<string>",
        "internal_name": "<string>"
      },
      "unit_size": "<string>",
      "price": {
        "currency": {
          "id": 123,
          "char_code": "<string>",
          "symbol": "<string>"
        },
        "money_value": "<string>",
        "price_stages": [
          {
            "threshold": "<string>",
            "money_value": "<string>"
          }
        ]
      },
      "default_value": "<string>",
      "rounding_rule": {
        "unit": {
          "id": 2,
          "name": "<string>",
          "internal_name": "<string>"
        },
        "value": "<string>",
        "round_operation": "ceil"
      },
      "comment": "<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

addendum_id
integer[]

Filter by Addendum ID. Can be multiple.

calc_rule_type
enum<string>[]

Filter by calculation rule type. Can be multiple.

  • commit - commit
  • overcommit - overcommit
  • stepped - stepped
  • staged - staged
  • unit - unit
  • post_invoice - post_invoice
comment
string
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 | null)[]

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

feature_id
integer[]

Filter by feature ID. Can be multiple.

feature_name
string

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

id
integer
limit
integer

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

metric_ext_name
string

Filter by metric code. Case insensitive. Supports partial matches.

metric_id
(integer | null)[]

Filter by metric ID. Can be multiple.

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.

  • id - Id
  • -id - Id (descending)
  • currency_id - Currency id
  • -currency_id - Currency id (descending)
  • calc_rule_type - Calc rule type
  • -calc_rule_type - Calc rule type (descending)
  • feature_name - Feature name
  • -feature_name - Feature name (descending)
  • product_name - Product name
  • -product_name - Product name (descending)
  • product_id - Product id
  • -product_id - Product id (descending)
  • plan_id - Plan id
  • -plan_id - Plan id (descending)
plan_id
integer[]

Filter by plan ID. Can be multiple.

plan_name
string

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

product_category_id
integer[]

Filter by Product Category ID. Can be multiple.

product_category_name
string

Filter by product category 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.

region_id
integer[]

Filter by region ID. Can be multiple.

region_int_name
string[]

Filter by region internal name. Can be multiple.

region_name
string

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

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"