Moodle PHP Documentation 4.4
Moodle 4.4.1 (Build: 20240610) (db07c09afc5)
|
The "subscriptions" collection of methods. More...
Public Member Functions | |
activate ($customerId, $subscriptionId, $optParams=array()) | |
Activates a subscription previously suspended by the reseller (subscriptions.activate) | |
call ($name, $arguments, $expected_class=null) | |
TODO: This function needs simplifying. | |
changePlan ($customerId, $subscriptionId, Google_Service_Reseller_ChangePlanRequest $postBody, $optParams=array()) | |
Changes the plan of a subscription (subscriptions.changePlan) | |
changeRenewalSettings ($customerId, $subscriptionId, Google_Service_Reseller_RenewalSettings $postBody, $optParams=array()) | |
Changes the renewal settings of a subscription (subscriptions.changeRenewalSettings) | |
changeSeats ($customerId, $subscriptionId, Google_Service_Reseller_Seats $postBody, $optParams=array()) | |
Changes the seats configuration of a subscription (subscriptions.changeSeats) | |
delete ($customerId, $subscriptionId, $deletionType, $optParams=array()) | |
Cancels/Downgrades a subscription. | |
get ($customerId, $subscriptionId, $optParams=array()) | |
Gets a subscription of the customer. | |
insert ($customerId, Google_Service_Reseller_Subscription $postBody, $optParams=array()) | |
Creates/Transfers a subscription for the customer. | |
listSubscriptions ($optParams=array()) | |
Lists subscriptions of a reseller, optionally filtered by a customer name prefix. | |
startPaidService ($customerId, $subscriptionId, $optParams=array()) | |
Starts paid service of a trial subscription (subscriptions.startPaidService) | |
suspend ($customerId, $subscriptionId, $optParams=array()) | |
Suspends an active subscription (subscriptions.suspend) | |
Protected Member Functions | |
convertToArrayAndStripNulls ($o) | |
The "subscriptions" collection of methods.
Typical usage is: $resellerService = new Google_Service_Reseller(...); $subscriptions = $resellerService->subscriptions;
Google_Service_Reseller_Subscriptions_Resource::activate | ( | $customerId, | |
$subscriptionId, | |||
$optParams = array() ) |
Activates a subscription previously suspended by the reseller (subscriptions.activate)
string | $customerId | Id of the Customer |
string | $subscriptionId | Id of the subscription, which is unique for a customer |
array | $optParams | Optional parameters. |
Google_Service_Reseller_Subscription |
|
inherited |
TODO: This function needs simplifying.
$name | |
$arguments | |
$expected_class | - optional, the expected class name |
Google_Http_Request|expected_class |
Google_Exception |
Google_Service_Reseller_Subscriptions_Resource::changePlan | ( | $customerId, | |
$subscriptionId, | |||
Google_Service_Reseller_ChangePlanRequest | $postBody, | ||
$optParams = array() ) |
Changes the plan of a subscription (subscriptions.changePlan)
string | $customerId | Id of the Customer |
string | $subscriptionId | Id of the subscription, which is unique for a customer |
Google_ChangePlanRequest | $postBody | |
array | $optParams | Optional parameters. |
Google_Service_Reseller_Subscription |
Google_Service_Reseller_Subscriptions_Resource::changeRenewalSettings | ( | $customerId, | |
$subscriptionId, | |||
Google_Service_Reseller_RenewalSettings | $postBody, | ||
$optParams = array() ) |
Changes the renewal settings of a subscription (subscriptions.changeRenewalSettings)
string | $customerId | Id of the Customer |
string | $subscriptionId | Id of the subscription, which is unique for a customer |
Google_RenewalSettings | $postBody | |
array | $optParams | Optional parameters. |
Google_Service_Reseller_Subscription |
Google_Service_Reseller_Subscriptions_Resource::changeSeats | ( | $customerId, | |
$subscriptionId, | |||
Google_Service_Reseller_Seats | $postBody, | ||
$optParams = array() ) |
Changes the seats configuration of a subscription (subscriptions.changeSeats)
string | $customerId | Id of the Customer |
string | $subscriptionId | Id of the subscription, which is unique for a customer |
Google_Seats | $postBody | |
array | $optParams | Optional parameters. |
Google_Service_Reseller_Subscription |
Google_Service_Reseller_Subscriptions_Resource::delete | ( | $customerId, | |
$subscriptionId, | |||
$deletionType, | |||
$optParams = array() ) |
Cancels/Downgrades a subscription.
(subscriptions.delete)
string | $customerId | Id of the Customer |
string | $subscriptionId | Id of the subscription, which is unique for a customer |
string | $deletionType | Whether the subscription is to be fully cancelled or downgraded |
array | $optParams | Optional parameters. |
Google_Service_Reseller_Subscriptions_Resource::get | ( | $customerId, | |
$subscriptionId, | |||
$optParams = array() ) |
Gets a subscription of the customer.
(subscriptions.get)
string | $customerId | Id of the Customer |
string | $subscriptionId | Id of the subscription, which is unique for a customer |
array | $optParams | Optional parameters. |
Google_Service_Reseller_Subscription |
Google_Service_Reseller_Subscriptions_Resource::insert | ( | $customerId, | |
Google_Service_Reseller_Subscription | $postBody, | ||
$optParams = array() ) |
Creates/Transfers a subscription for the customer.
(subscriptions.insert)
string | $customerId | Id of the Customer |
Google_Subscription | $postBody | |
array | $optParams | Optional parameters. |
@opt_param string customerAuthToken An auth token needed for transferring a subscription. Can be generated at https://www.google.com/a/cpanel/customer- domain/TransferToken. Optional.
Google_Service_Reseller_Subscription |
Google_Service_Reseller_Subscriptions_Resource::listSubscriptions | ( | $optParams = array() | ) |
Lists subscriptions of a reseller, optionally filtered by a customer name prefix.
(subscriptions.listSubscriptions)
array | $optParams | Optional parameters. |
@opt_param string customerAuthToken An auth token needed if the customer is not a resold customer of this reseller. Can be generated at https://www.google.com/a/cpanel/customer-domain/TransferToken.Optional. @opt_param string pageToken Token to specify next page in the list @opt_param string customerId Id of the Customer @opt_param string maxResults Maximum number of results to return @opt_param string customerNamePrefix Prefix of the customer's domain name by which the subscriptions should be filtered. Optional
Google_Service_Reseller_Subscriptions |
Google_Service_Reseller_Subscriptions_Resource::startPaidService | ( | $customerId, | |
$subscriptionId, | |||
$optParams = array() ) |
Starts paid service of a trial subscription (subscriptions.startPaidService)
string | $customerId | Id of the Customer |
string | $subscriptionId | Id of the subscription, which is unique for a customer |
array | $optParams | Optional parameters. |
Google_Service_Reseller_Subscription |
Google_Service_Reseller_Subscriptions_Resource::suspend | ( | $customerId, | |
$subscriptionId, | |||
$optParams = array() ) |
Suspends an active subscription (subscriptions.suspend)
string | $customerId | Id of the Customer |
string | $subscriptionId | Id of the subscription, which is unique for a customer |
array | $optParams | Optional parameters. |
Google_Service_Reseller_Subscription |