Create Zone Subscription

POST

https://api.cloudflare.com/client/v4/zones/{identifier}/subscription

Last modified:2022-12-16 13:48:36

Create a zone subscription, either plan or add-ons.

Request

Path Params

identifier

string

required

Body Params application/json

app

object

optional

install_id

string

optional

app install id.

component_values

array[object (component_value) {4}]

optional

The list of add-ons subscribed to.

default

number

optional

The default amount assigned.

Example:

name

string

optional

The name of the component value.

Example:

page_rules

price

number

optional

The unit price for the component value.

Example:

value

number

optional

The amount of the component value assigned.

Example:

frequency

enum<string>

optional

How often the subscription is renewed automatically.

Allowed values:

weeklymonthlyquarterlyyearly

Example:

monthly

rate_plan

object (rate_plan)

optional

The rate plan applied to the subscription.

currency

string

optional

The currency applied to the rate plan subscription.

Example:

USD

externally_managed

boolean

optional

Whether this rate plan is managed externally from Cloudflare.

Example:

false

optional

The ID of the rate plan.

Example:

free

is_contract

boolean

optional

Whether a rate plan is enterprise-based (or newly adopted term contract).

Example:

false

public_name

string

optional

The full name of the rate plan.

Example:

Business Plan

scope

string

optional

The scope that this rate plan applies to.

Example:

zone

sets

array[string]

optional

The list of sets this rate plan applies to.

zone

object (zone)

optional

A simple zone object. May have null properties if not a zone subscription.

Example

{
    "app": {
        "install_id": "string"
    },
    "component_values": [
        {
            "default": 5,
            "name": "page_rules",
            "price": 5,
            "value": 20
        }
    ],
    "frequency": "monthly",
    "rate_plan": {
        "currency": "USD",
        "externally_managed": false,
        "id": "free",
        "is_contract": false,
        "public_name": "Business Plan",
        "scope": "zone",
        "sets": [
            "string"
        ]
    },
    "zone": {}
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://api.cloudflare.com/client/v4/zones//subscription' \
--header 'Content-Type: application/json' \
--data-raw '{
    "app": {
        "install_id": "string"
    },
    "component_values": [
        {
            "default": 5,
            "name": "page_rules",
            "price": 5,
            "value": 20
        }
    ],
    "frequency": "monthly",
    "rate_plan": {
        "currency": "USD",
        "externally_managed": false,
        "id": "free",
        "is_contract": false,
        "public_name": "Business Plan",
        "scope": "zone",
        "sets": [
            "string"
        ]
    },
    "zone": {}
}'

Responses

🟢200Create Zone Subscription response

application/json

Body

allOf {2}

optional

object (api-response-single)

optional

errors

array [object {2}]

messages

required

Example:

[]

messages

array [object {2}]

messages

required

Example:

[]

result

required

success

enum<boolean>

required

Whether the API call was successful

Allowed value:

true

Example:

true

object

optional

result

object

optional

Example

{
    "errors": [],
    "messages": [],
    "result": {},
    "success": true
}

🟢200Create Zone Subscription response failure

Modified at 2022-12-16 13:48:36

Zone Subscription Details

Update Zone Subscription