PHP Class Cloudflare\User\Billing\Subscriptions\Zones

Billing Zone Subscription
Author: James Bell ([email protected])
Inheritance: extends Cloudflare\User\Billing
Show file Open project: jamesryanbell/cloudflare

Public Methods

Method Description
info ( string $identifier ) Info (permission needed: #billing:read) Billing subscription details
list_zones ( ) List (permission needed: #billing:read) List all of your zone plan subscriptions
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

Method Details

info() public method

Info (permission needed: #billing:read) Billing subscription details
public info ( string $identifier )
$identifier string API item identifier tag

list_zones() public method

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

search_sort_paginate() public method

Search, sort, and paginate (permission needed: #billing:read) Search, sort, and paginate your 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 )
$page integer | null Page number of paginated results
$per_page integer | null Number of items per page
$order string | null Field to order subscriptions by
$status string | null The state of the subscription
$price string | null The price of the subscription that will be billed, in US dollars
$activated_on string | null When the subscription was activated
$expires_on string | null When the subscription will expire
$expired_on string | null When the subscription expired
$cancelled_on string | null When the subscription was cancelled
$renewed_on string | null When the subscription was renewed
$direction string | null Direction to order subscriptions
$match string | null Whether to match all search requirements or at least one (any)