subscriptions

Creates, updates, deletes, gets or lists a subscriptions resource.

Overview

Name	subscriptions
Type	Resource
Id	cloudflare.accounts.subscriptions

Fields

The following fields are returned by SELECT queries:

list

List Subscriptions response

Name	Datatype	Description
errors	array
messages	array
result	array
result_info	object
success	boolean	Whether the API call was successful (true)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list	select	account_id		Lists all of an account's subscriptions.
create	insert	account_id		Creates an account subscription.
update	replace	subscription_identifier, account_id		Updates an account subscription.
delete	delete	subscription_identifier, account_id		Deletes an account's subscription.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
account_id	string	The Cloudflare account ID.
subscription_identifier	string

SELECT examples

list

Lists all of an account's subscriptions.

SELECT
errors,
messages,
result,
result_info,
success
FROM cloudflare.accounts.subscriptions
WHERE account_id = '{{ account_id }}' -- required
;

INSERT examples

create

Creates an account subscription.

INSERT INTO cloudflare.accounts.subscriptions (
frequency,
rate_plan,
account_id
)
SELECT 
'{{ frequency }}',
'{{ rate_plan }}',
'{{ account_id }}'
RETURNING
errors,
messages,
result,
success
;

Manifest

# Description fields are for documentation purposes
- name: subscriptions
props:
  - name: account_id
    value: "{{ account_id }}"
    description: Required parameter for the subscriptions resource.
  - name: frequency
    value: "{{ frequency }}"
    description: |
      How often the subscription is renewed automatically.
    valid_values: ['weekly', 'monthly', 'quarterly', 'yearly']
  - name: rate_plan
    description: |
      The rate plan applied to the subscription.
    value:
      currency: "{{ currency }}"
      externally_managed: {{ externally_managed }}
      id: "{{ id }}"
      is_contract: {{ is_contract }}
      public_name: "{{ public_name }}"
      scope: "{{ scope }}"
      sets:
        - "{{ sets }}"

REPLACE examples

update

Updates an account subscription.

REPLACE cloudflare.accounts.subscriptions
SET 
frequency = '{{ frequency }}',
rate_plan = '{{ rate_plan }}'
WHERE 
subscription_identifier = '{{ subscription_identifier }}' --required
AND account_id = '{{ account_id }}' --required
RETURNING
errors,
messages,
result,
success;

DELETE examples

delete

Deletes an account's subscription.

DELETE FROM cloudflare.accounts.subscriptions
WHERE subscription_identifier = '{{ subscription_identifier }}' --required
AND account_id = '{{ account_id }}' --required
;