Overview

Namespaces

  • Cloudflare
    • Organizations
      • Firewall
        • AccessRules
    • User
      • Billing
        • Subscriptions
      • Firewall
    • Zone
      • Firewall
      • SSL
      • WAF
        • Packages

Classes

  • Apps
  • Zones
  • Overview
  • Namespace
  • Class

Class Zones

CloudFlare API wrapper

Billing Zone Subscription

Cloudflare\Api
Extended by Cloudflare\User\Billing\Subscriptions\Zones
Namespace: Cloudflare\User\Billing\Subscriptions
Author: James Bell james@james-bell.co.uk
Version: 1
Located at CloudFlare/User/Billing/Subscriptions/Zones.php
Methods summary
public
# list_zones( )

List (permission needed: #billing:read) List all of your zone plan subscriptions

List (permission needed: #billing:read) List all of your zone plan subscriptions

public
# search_sort_paginate( integer|null $page = null, integer|null $per_page = null, string|null $order = null, string|null $status = null, string|null $price = null, string|null $activated_on = null, string|null $expires_on = null, string|null $expired_on = null, string|null $cancelled_on = null, string|null $renewed_on = null, string|null $direction = null, string|null $match = null )

Search, sort, and paginate (permission needed: #billing:read) Search, sort, and paginate your subscriptions

Search, sort, and paginate (permission needed: #billing:read) Search, sort, and paginate your subscriptions

Parameters

$page
Page number of paginated results
$per_page
Number of items per page
$order
Field to order subscriptions by
$status
The state of the subscription
$price
The price of the subscription that will be billed, in US dollars
$activated_on
When the subscription was activated
$expires_on
When the subscription will expire
$expired_on
When the subscription expired
$cancelled_on
When the subscription was cancelled
$renewed_on
When the subscription was renewed
$direction
Direction to order subscriptions
$match
Whether to match all search requirements or at least one (any)
public
# info( string $identifier )

Info (permission needed: #billing:read) Billing subscription details

Info (permission needed: #billing:read) Billing subscription details

Parameters

$identifier
API item identifier tag
Methods inherited from Cloudflare\Api
__construct(), delete(), get(), patch(), permissions(), post(), put(), request(), setAuthKey(), setCurlOption(), setEmail()
Properties summary
protected array $permission_level

Default permissions level

Default permissions level

# ['read' => '#billing:read', 'edit' => '#billing:edit']
Properties inherited from Cloudflare\Api
$auth_key, $curl_options, $email
API documentation generated by ApiGen