List PlanContents

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

Available options:

commit,

overcommit,

post_invoice,

staged,

stepped,

unit

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.

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)

Available options:

-calc_rule_type,

-currency_id,

-feature_name,

-id,

-plan_id,

-product_id,

-product_name,

calc_rule_type,

currency_id,

feature_name,

id,

plan_id,

product_id,

product_name

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

Show child attributes

results.id

integer

required

results.plan_id

integer

required

Tariff plan

results.default

boolean

required

Indicates whether the plan item is activated by default when the tariff is purchased.

results.feature

object

required

Feature associated with the plan item.

Show child attributes

results.feature.id

integer

required

results.feature.name

string

required

results.feature.erp_sku_id

string | null

required

results.metric_ext_name

string

required

Metric code of the feature associated with the expense.

results.regions

object[]

required

Show child attributes

results.regions.id

integer

required

results.regions.name

string

required

results.regions.external_name

string

required

results.product_category

object

required

Product category of the feature associated with the plan item.

Show child attributes

results.product_category.id

integer

required

results.product_category.name

string

required

Maximum string length: 255

results.product

object

required

Product associated with the plan.

Show child attributes

results.product.id

integer

required

results.product.name

string

required

results.product.internal_name

string

required

Maximum string length: 25

results.calc_rule_type

string

required

Type of calculation rule for the plan item.

results.unit

object

required

Unit of measurement for the plan item. It is used for rounding and pricing calculations.

Show child attributes

results.unit.id

integer

required

Unique internal identifier of the unit.

Required range: x >= 1

results.unit.name

string

required

Name of the unit.

results.unit.internal_name

string

required

Internal name of the unit.

results.unit_size

string<decimal>

required

Specifies the quantity of the unit used for calculating the plan item's price and default_value.

results.price

object

required

Price associated with the plan item for the specified unit of measurement.

Show child attributes

results.price.currency

object

required

Currency of the price, used for monetary calculations.

Show child attributes

results.price.currency.id

integer

required

results.price.currency.char_code

string

required

Currency iso4217 char code

Maximum string length: 3

results.price.currency.symbol

string | null

Currency symbol, for example '$'

Maximum string length: 10

results.price.money_value

string<decimal>

required

The monetary value of the price in the specified currency.

results.price.price_stages

object[]

required

Stages of the price, if applicable.

Show child attributes

results.price.price_stages.threshold

string<decimal>

required

Threshold for the price in the specified unit.

results.price.price_stages.money_value

string<decimal>

required

The monetary value of the price stage in the specified currency.

results.default_value

string<decimal>

required

Default value for the plan item in the specified unit. This value is used when the plan item is activated by default.

results.rounding_rule

object

required

Rounding rule for the plan item.

Show child attributes

results.rounding_rule.unit

object

required

Unit of measurement for the rounding rule.

Show child attributes

results.rounding_rule.unit.id

integer

required

Unique internal identifier of the unit.

Required range: x >= 1

results.rounding_rule.unit.name

string

required

Name of the unit.

results.rounding_rule.unit.internal_name

string

required

Internal name of the unit.

results.rounding_rule.value

string<decimal>

required

Value for the rounding rule in the specified unit.

results.rounding_rule.round_operation

enum<string>

ceil - ceil
floor - floor

Available options:

ceil,

floor

results.comment

string

required

Comment for the plan item.

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"

Overview

IAM

CDN

Managed DNS

Cloud

DDoS Protection

FastEdge

WAAP

Streaming

Object Storage

Resellers

Authorizations

Query Parameters

Response