subscriptions

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

Overview

Name	subscriptions
Type	Resource
Id	cloudflare.user.subscriptions

Fields

The following fields are returned by SELECT queries:

list

Get User 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			Lists all of a user's subscriptions.
update	replace	identifier		Updates a user's subscriptions.
delete	delete	identifier		Deletes a user'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
identifier	string	Resource identifier.

SELECT examples

list

Lists all of a user's subscriptions.

SELECT
errors,
messages,
result,
result_info,
success
FROM cloudflare.user.subscriptions
;

REPLACE examples

update

Updates a user's subscriptions.

REPLACE cloudflare.user.subscriptions
SET 
frequency = '{{ frequency }}',
rate_plan = '{{ rate_plan }}'
WHERE 
identifier = '{{ identifier }}' --required
RETURNING
errors,
messages,
result,
success;

DELETE examples

delete

Deletes a user's subscription.

DELETE FROM cloudflare.user.subscriptions
WHERE identifier = '{{ identifier }}' --required
;