PUT /user/subscriptions/{identifier}
Updates a user's subscriptions.
Servers
- https://api.cloudflare.com/client/v4
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
identifier |
String | Yes |
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
id |
String | No |
Subscription identifier tag. |
component_values[] |
Array | No |
The list of add-ons subscribed to. |
component_values[].price |
Number | No |
The unit price for the component value. |
component_values[].name |
String | No |
The name of the component value. |
component_values[].default |
Number | No |
The default amount assigned. |
component_values[].value |
Number | No |
The amount of the component value assigned. |
price |
Number | No |
The price of the subscription that will be billed, in US dollars. |
frequency |
String | No |
How often the subscription is renewed automatically. Possible values:
|
current_period_end |
String | No |
The end of the current period and also when the next billing is due. |
zone |
Object | No |
A simple zone object. May have null properties if not a zone subscription. |
zone.id |
String | No |
Identifier |
zone.name |
String | No |
The domain name |
rate_plan |
Object | No |
The rate plan applied to the subscription. |
rate_plan.id |
String | No |
The ID of the rate plan. |
rate_plan.sets[] |
Array | No |
The list of sets this rate plan applies to. |
rate_plan.is_contract |
Boolean | No |
Whether a rate plan is enterprise-based (or newly adopted term contract). |
rate_plan.public_name |
String | No |
The full name of the rate plan. |
rate_plan.scope |
String | No |
The scope that this rate plan applies to. |
rate_plan.currency |
String | No |
The currency applied to the rate plan subscription. |
rate_plan.externally_managed |
Boolean | No |
Whether this rate plan is managed externally from Cloudflare. |
current_period_start |
String | No |
When the current billing period started. May match initial_period_start if this is the first period. |
state |
String | No |
The state that the subscription is in. Possible values:
|
currency |
String | No |
The monetary unit in which pricing information is displayed. |
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.