POST /accounts/{account_id}/bulk/subscriptions
Creates multiple subscriptions for an account in a single request.
Servers
- https://api.cloudflare.com/client/v4
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
account_id |
String | Yes |
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
idemp_key |
String | No |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
payment_hold_id |
Integer | No | |
coupon_code |
String | No | |
subscriptions[] |
Array | No | |
subscriptions[].id |
String | No |
Subscription identifier tag. |
subscriptions[].component_values[] |
Array | No |
Configurable component values for the subscription. |
subscriptions[].component_values[].price |
Number | No |
The unit price for the component value. |
subscriptions[].component_values[].name |
String | No |
The name of the component value. |
subscriptions[].component_values[].default |
Number | No |
The default amount assigned. |
subscriptions[].component_values[].display_name |
String | No |
A human-readable version of the component name. |
subscriptions[].component_values[].value |
Number | No |
The amount of the component value assigned. |
subscriptions[].component_values[].kind |
String | No |
The type of component value. "enum" for discrete values (including boolean on/off toggles where 0=off and 1=on), "sum" for countable quantities, "usage" for metered billing components. Valid values:
|
subscriptions[].price |
Number | No |
The price of the subscription that will be billed, in US dollars. |
subscriptions[].frequency |
String | No |
How often the subscription is renewed automatically. Valid values:
|
subscriptions[].app |
Object | No |
Cloudflare Apps Marketplace is sunset. This field is retained for legacy grandfathered app subscriptions only. |
subscriptions[].app.install_id |
String | No |
app install id. |
subscriptions[].current_period_end |
String | No |
The end of the current period and also when the next billing is due. |
subscriptions[].zone |
Object | No |
A simple zone object. May have null properties if not a zone subscription. |
subscriptions[].zone.id |
String | No |
Identifier |
subscriptions[].zone.name |
String | No |
The domain name |
subscriptions[].rate_plan |
Object | No |
The rate plan applied to the subscription. |
subscriptions[].rate_plan.id |
String | No |
The ID of the rate plan. |
subscriptions[].rate_plan.sets[] |
Array | No |
The list of sets this rate plan applies to. Returns array of strings. |
subscriptions[].rate_plan.is_contract |
Boolean | No |
Whether a rate plan is enterprise-based (or newly adopted term contract). |
subscriptions[].rate_plan.public_name |
String | No |
The full name of the rate plan. |
subscriptions[].rate_plan.scope |
String | No |
The scope that this rate plan applies to. |
subscriptions[].rate_plan.currency |
String | No |
The currency applied to the rate plan subscription. |
subscriptions[].rate_plan.externally_managed |
Boolean | No |
Whether this rate plan is managed externally from Cloudflare. |
subscriptions[].current_period_start |
String | No |
When the current billing period started. May match initial_period_start if this is the first period. |
subscriptions[].state |
String | No |
The state that the subscription is in. Valid values:
|
subscriptions[].currency |
String | No |
The monetary unit in which pricing information is displayed. |
user_is_on_session |
Boolean | No |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.