List Available Rate Plans

Lists all rate plans the zone can subscribe to.

application/json

Body

result

required

Any of

allOf {2}

array[object (schemas-rate-plan) {6}]

allOf {2}

One of

array[object (schemas-rate-plan) {6}]

object

components

array[object (component-value) {3}]

schemas-component_values

optional

Array of available components values for the plan.

currency

string

currency

read-onlyoptional

The monetary unit in which pricing information is displayed.

Example:

USD

duration

number

Cloudflare Client API_duration

optional

The duration of the plan subscription.

Example:

frequency

enum<string>

schemas-frequency

read-onlyoptional

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

Allowed values:

weeklymonthlyquarterlyyearly

Example:

monthly

string

rate-plan_components-schemas-identifier

read-onlyoptional

Plan identifier tag.

Example:

free

name

string

rate-plan_components-schemas-name

read-onlyoptional

The plan name.

<= 80 characters

Example:

Free Plan

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": [
        {
            "components": [
                {
                    "default": 5,
                    "name": "page_rules",
                    "unit_price": 1
                }
            ],
            "currency": "USD",
            "duration": 1,
            "frequency": "monthly",
            "id": "free",
            "name": "Free Plan"
        }
    ],
    "success": true,
    "result_info": {
        "count": 1,
        "page": 1,
        "per_page": 20,
        "total_count": 2000
    }
}

List Available Rate Plans

Request

Request samples

Responses