List Available Plans

Lists available plans the zone can subscribe to.

application/json

Body

result

required

Any of

allOf {2}

array[object (available-rate-plan) {10}]

allOf {2}

One of

array[object (available-rate-plan) {10}]

object

can_subscribe

boolean

can_subscribe

optional

Indicates whether you can subscribe to this plan.

Default:

false

Example:

true

currency

string

currency

read-onlyoptional

The monetary unit in which pricing information is displayed.

Example:

USD

externally_managed

boolean

externally_managed

optional

Indicates whether this plan is managed externally.

Default:

false

Example:

false

frequency

enum<string>

schemas-frequency

read-onlyoptional

The frequency at which you will be billed for this plan.

Allowed values:

weeklymonthlyquarterlyyearly

Example:

monthly

string

common_components-schemas-identifier

read-onlyoptional

Identifier

<= 32 characters

Example:

023e105f4ecef8ad9ca31a8372d0c353

is_subscribed

boolean

is_subscribed

optional

Indicates whether you are currently subscribed to this plan.

Default:

false

Example:

false

legacy_discount

boolean

legacy_discount

optional

Indicates whether this plan has a legacy discount applied.

Default:

false

Example:

false

legacy_id

string

legacy_id

read-onlyoptional

The legacy identifier for this rate plan, if any.

Example:

free

name

string

rate-plan_components-schemas-name

read-onlyoptional

The plan name.

<= 80 characters

Example:

Free Plan

price

number

schemas-price

optional

The amount you will be billed for this plan.

Example:

errors

array [object {2}]

messages

required

Example:

[]

code

integer

required

>= 1000

message

string

required

messages

array [object {2}]

messages

required

Example:

[]

code

integer

required

>= 1000

message

string

required

success

enum<boolean>

required

Whether the API call was successful

Allowed value:

true

Example:

true

result_info

object

result_info

optional

count

number

optional

Total number of results for the requested service

Example:

page

number

optional

Current page within paginated list of results

Example:

per_page

number

optional

Number of results per page of results

Example:

total_count

number

optional

Total results available without any search parameters

Example:

2000

Example

{
    "errors": [],
    "messages": [],
    "result": [
        {
            "can_subscribe": true,
            "currency": "USD",
            "externally_managed": false,
            "frequency": "monthly",
            "id": "023e105f4ecef8ad9ca31a8372d0c353",
            "is_subscribed": false,
            "legacy_discount": false,
            "legacy_id": "free",
            "name": "Free Plan",
            "price": 0
        }
    ],
    "success": true,
    "result_info": {
        "count": 1,
        "page": 1,
        "per_page": 20,
        "total_count": 2000
    }
}

List Available Plans

Request

Request samples

Responses