#include <subscription.h>

Inheritance diagram for google_reseller_api::Subscription:

Classes
class	SubscriptionPlan

class	SubscriptionTransferInfo

class	SubscriptionTrialSettings

Public Member Functions
	Subscription (const Json::Value &storage)

	Subscription (Json::Value *storage)

virtual	~Subscription ()

const StringPiece	GetTypeName () const

bool	has_billing_method () const

void	clear_billing_method ()

const StringPiece	get_billing_method () const

void	set_billing_method (const StringPiece &value)

bool	has_creation_time () const

void	clear_creation_time ()

int64	get_creation_time () const

void	set_creation_time (int64 value)

bool	has_customer_domain () const

void	clear_customer_domain ()

const StringPiece	get_customer_domain () const

void	set_customer_domain (const StringPiece &value)

bool	has_customer_id () const

void	clear_customer_id ()

const StringPiece	get_customer_id () const

void	set_customer_id (const StringPiece &value)

bool	has_deal_code () const

void	clear_deal_code ()

const StringPiece	get_deal_code () const

void	set_deal_code (const StringPiece &value)

bool	has_kind () const

void	clear_kind ()

const StringPiece	get_kind () const

void	set_kind (const StringPiece &value)

bool	has_plan () const

void	clear_plan ()

const SubscriptionPlan	get_plan () const

SubscriptionPlan	mutable_plan ()

bool	has_purchase_order_id () const

void	clear_purchase_order_id ()

const StringPiece	get_purchase_order_id () const

void	set_purchase_order_id (const StringPiece &value)

bool	has_renewal_settings () const

void	clear_renewal_settings ()

const RenewalSettings	get_renewal_settings () const

RenewalSettings	mutable_renewalSettings ()

bool	has_resource_ui_url () const

void	clear_resource_ui_url ()

const StringPiece	get_resource_ui_url () const

void	set_resource_ui_url (const StringPiece &value)

bool	has_seats () const

void	clear_seats ()

const Seats	get_seats () const

Seats	mutable_seats ()

bool	has_sku_id () const

void	clear_sku_id ()

const StringPiece	get_sku_id () const

void	set_sku_id (const StringPiece &value)

bool	has_sku_name () const

void	clear_sku_name ()

const StringPiece	get_sku_name () const

void	set_sku_name (const StringPiece &value)

bool	has_status () const

void	clear_status ()

const StringPiece	get_status () const

void	set_status (const StringPiece &value)

bool	has_subscription_id () const

void	clear_subscription_id ()

const StringPiece	get_subscription_id () const

void	set_subscription_id (const StringPiece &value)

bool	has_suspension_reasons () const

void	clear_suspension_reasons ()

const client::JsonCppArray< string >	get_suspension_reasons () const

client::JsonCppArray< string >	mutable_suspensionReasons ()

bool	has_transfer_info () const

void	clear_transfer_info ()

const SubscriptionTransferInfo	get_transfer_info () const

SubscriptionTransferInfo	mutable_transferInfo ()

bool	has_trial_settings () const

void	clear_trial_settings ()

const SubscriptionTrialSettings	get_trial_settings () const

SubscriptionTrialSettings	mutable_trialSettings ()

Static Public Member Functions
static Subscription *	New ()

Detailed Description

JSON template for a subscription.

Constructor & Destructor Documentation

◆ Subscription() [1/2]

google_reseller_api::Subscription::Subscription ( const Json::Value & storage )

explicit

Standard constructor for an immutable data object instance.

Parameters

[in] storage The underlying data storage for this instance.

◆ Subscription() [2/2]

google_reseller_api::Subscription::Subscription ( Json::Value * storage )

explicit

Standard constructor for a mutable data object instance.

Parameters

[in] storage The underlying data storage for this instance.

◆ ~Subscription()

google_reseller_api::Subscription::~Subscription ( )

virtual

Standard destructor.

Member Function Documentation

◆ clear_billing_method()

void google_reseller_api::Subscription::clear_billing_method ( )

inline

Clears the 'billingMethod' attribute.

◆ clear_creation_time()

void google_reseller_api::Subscription::clear_creation_time ( )

inline

Clears the 'creationTime' attribute.

◆ clear_customer_domain()

void google_reseller_api::Subscription::clear_customer_domain ( )

inline

Clears the 'customerDomain' attribute.

◆ clear_customer_id()

void google_reseller_api::Subscription::clear_customer_id ( )

inline

Clears the 'customerId' attribute.

◆ clear_deal_code()

void google_reseller_api::Subscription::clear_deal_code ( )

inline

Clears the 'dealCode' attribute.

◆ clear_kind()

void google_reseller_api::Subscription::clear_kind ( )

inline

Clears the 'kind' attribute.

◆ clear_plan()

void google_reseller_api::Subscription::clear_plan ( )

inline

Clears the 'plan' attribute.

◆ clear_purchase_order_id()

void google_reseller_api::Subscription::clear_purchase_order_id ( )

inline

Clears the 'purchaseOrderId' attribute.

◆ clear_renewal_settings()

void google_reseller_api::Subscription::clear_renewal_settings ( )

inline

Clears the 'renewalSettings' attribute.

◆ clear_resource_ui_url()

void google_reseller_api::Subscription::clear_resource_ui_url ( )

inline

Clears the 'resourceUiUrl' attribute.

◆ clear_seats()

void google_reseller_api::Subscription::clear_seats ( )

inline

Clears the 'seats' attribute.

◆ clear_sku_id()

void google_reseller_api::Subscription::clear_sku_id ( )

inline

Clears the 'skuId' attribute.

◆ clear_sku_name()

void google_reseller_api::Subscription::clear_sku_name ( )

inline

Clears the 'skuName' attribute.

◆ clear_status()

void google_reseller_api::Subscription::clear_status ( )

inline

Clears the 'status' attribute.

◆ clear_subscription_id()

void google_reseller_api::Subscription::clear_subscription_id ( )

inline

Clears the 'subscriptionId' attribute.

◆ clear_suspension_reasons()

void google_reseller_api::Subscription::clear_suspension_reasons ( )

inline

Clears the 'suspensionReasons' attribute.

◆ clear_transfer_info()

void google_reseller_api::Subscription::clear_transfer_info ( )

inline

Clears the 'transferInfo' attribute.

◆ clear_trial_settings()

void google_reseller_api::Subscription::clear_trial_settings ( )

inline

Clears the 'trialSettings' attribute.

◆ get_billing_method()

const StringPiece google_reseller_api::Subscription::get_billing_method ( ) const

inline

Get the value of the 'billingMethod' attribute.

◆ get_creation_time()

int64 google_reseller_api::Subscription::get_creation_time ( ) const

inline

Get the value of the 'creationTime' attribute.

◆ get_customer_domain()

const StringPiece google_reseller_api::Subscription::get_customer_domain ( ) const

inline

Get the value of the 'customerDomain' attribute.

◆ get_customer_id()

const StringPiece google_reseller_api::Subscription::get_customer_id ( ) const

inline

Get the value of the 'customerId' attribute.

◆ get_deal_code()

const StringPiece google_reseller_api::Subscription::get_deal_code ( ) const

inline

Get the value of the 'dealCode' attribute.

◆ get_kind()

const StringPiece google_reseller_api::Subscription::get_kind ( ) const

inline

Get the value of the 'kind' attribute.

◆ get_plan()

const SubscriptionPlan google_reseller_api::Subscription::get_plan ( ) const

inline

Get a reference to the value of the 'plan' attribute.

◆ get_purchase_order_id()

const StringPiece google_reseller_api::Subscription::get_purchase_order_id ( ) const

inline

Get the value of the 'purchaseOrderId' attribute.

◆ get_renewal_settings()

const RenewalSettings google_reseller_api::Subscription::get_renewal_settings ( ) const

Get a reference to the value of the 'renewalSettings' attribute.

◆ get_resource_ui_url()

const StringPiece google_reseller_api::Subscription::get_resource_ui_url ( ) const

inline

Get the value of the 'resourceUiUrl' attribute.

◆ get_seats()

const Seats google_reseller_api::Subscription::get_seats ( ) const

Get a reference to the value of the 'seats' attribute.

◆ get_sku_id()

const StringPiece google_reseller_api::Subscription::get_sku_id ( ) const

inline

Get the value of the 'skuId' attribute.

◆ get_sku_name()

const StringPiece google_reseller_api::Subscription::get_sku_name ( ) const

inline

Get the value of the 'skuName' attribute.

◆ get_status()

const StringPiece google_reseller_api::Subscription::get_status ( ) const

inline

Get the value of the 'status' attribute.

◆ get_subscription_id()

const StringPiece google_reseller_api::Subscription::get_subscription_id ( ) const

inline

Get the value of the 'subscriptionId' attribute.

◆ get_suspension_reasons()

const client::JsonCppArray<string > google_reseller_api::Subscription::get_suspension_reasons ( ) const

inline

Get a reference to the value of the 'suspensionReasons' attribute.

◆ get_transfer_info()

const SubscriptionTransferInfo google_reseller_api::Subscription::get_transfer_info ( ) const

inline

Get a reference to the value of the 'transferInfo' attribute.

◆ get_trial_settings()

const SubscriptionTrialSettings google_reseller_api::Subscription::get_trial_settings ( ) const

inline

Get a reference to the value of the 'trialSettings' attribute.

◆ GetTypeName()

const StringPiece google_reseller_api::Subscription::GetTypeName ( ) const

inline

Returns a string denoting the type of this data object.

Returns: google_reseller_api::Subscription

◆ has_billing_method()

bool google_reseller_api::Subscription::has_billing_method ( ) const

inline

Determine if the 'billingMethod' attribute was set.

Returns: true if the 'billingMethod' attribute was set.

◆ has_creation_time()

bool google_reseller_api::Subscription::has_creation_time ( ) const

inline

Determine if the 'creationTime' attribute was set.

Returns: true if the 'creationTime' attribute was set.

◆ has_customer_domain()

bool google_reseller_api::Subscription::has_customer_domain ( ) const

inline

Determine if the 'customerDomain' attribute was set.

Returns: true if the 'customerDomain' attribute was set.

◆ has_customer_id()

bool google_reseller_api::Subscription::has_customer_id ( ) const

inline

Determine if the 'customerId' attribute was set.

Returns: true if the 'customerId' attribute was set.

◆ has_deal_code()

bool google_reseller_api::Subscription::has_deal_code ( ) const

inline

Determine if the 'dealCode' attribute was set.

Returns: true if the 'dealCode' attribute was set.

◆ has_kind()

bool google_reseller_api::Subscription::has_kind ( ) const

inline

Determine if the 'kind' attribute was set.

Returns: true if the 'kind' attribute was set.

◆ has_plan()

bool google_reseller_api::Subscription::has_plan ( ) const

inline

Determine if the 'plan' attribute was set.

Returns: true if the 'plan' attribute was set.

◆ has_purchase_order_id()

bool google_reseller_api::Subscription::has_purchase_order_id ( ) const

inline

Determine if the 'purchaseOrderId' attribute was set.

Returns: true if the 'purchaseOrderId' attribute was set.

◆ has_renewal_settings()

bool google_reseller_api::Subscription::has_renewal_settings ( ) const

inline

Determine if the 'renewalSettings' attribute was set.

Returns: true if the 'renewalSettings' attribute was set.

◆ has_resource_ui_url()

bool google_reseller_api::Subscription::has_resource_ui_url ( ) const

inline

Determine if the 'resourceUiUrl' attribute was set.

Returns: true if the 'resourceUiUrl' attribute was set.

◆ has_seats()

bool google_reseller_api::Subscription::has_seats ( ) const

inline

Determine if the 'seats' attribute was set.

Returns: true if the 'seats' attribute was set.

◆ has_sku_id()

bool google_reseller_api::Subscription::has_sku_id ( ) const

inline

Determine if the 'skuId' attribute was set.

Returns: true if the 'skuId' attribute was set.

◆ has_sku_name()

bool google_reseller_api::Subscription::has_sku_name ( ) const

inline

Determine if the 'skuName' attribute was set.

Returns: true if the 'skuName' attribute was set.

◆ has_status()

bool google_reseller_api::Subscription::has_status ( ) const

inline

Determine if the 'status' attribute was set.

Returns: true if the 'status' attribute was set.

◆ has_subscription_id()

bool google_reseller_api::Subscription::has_subscription_id ( ) const

inline

Determine if the 'subscriptionId' attribute was set.

Returns: true if the 'subscriptionId' attribute was set.

◆ has_suspension_reasons()

bool google_reseller_api::Subscription::has_suspension_reasons ( ) const

inline

Determine if the 'suspensionReasons' attribute was set.

Returns: true if the 'suspensionReasons' attribute was set.

◆ has_transfer_info()

bool google_reseller_api::Subscription::has_transfer_info ( ) const

inline

Determine if the 'transferInfo' attribute was set.

Returns: true if the 'transferInfo' attribute was set.

◆ has_trial_settings()

bool google_reseller_api::Subscription::has_trial_settings ( ) const

inline

Determine if the 'trialSettings' attribute was set.

Returns: true if the 'trialSettings' attribute was set.

◆ mutable_plan()

SubscriptionPlan google_reseller_api::Subscription::mutable_plan ( )

inline

Gets a reference to a mutable value of the 'plan' property.

The plan property is required. In this version of the API, the G Suite plans are the flexible plan, annual commitment plan, and the 30-day free trial plan. For more information about the API"s payment plans, see the API concepts.

Returns: The result can be modified to change the attribute value.

◆ mutable_renewalSettings()

RenewalSettings google_reseller_api::Subscription::mutable_renewalSettings ( )

Gets a reference to a mutable value of the 'renewalSettings' property.

Renewal settings for the annual commitment plan. For more detailed information, see renewal options in the administrator help center.

Returns: The result can be modified to change the attribute value.

◆ mutable_seats()

Seats google_reseller_api::Subscription::mutable_seats ( )

Gets a reference to a mutable value of the 'seats' property.

This is a required property. The number and limit of user seat licenses in the plan.

Returns: The result can be modified to change the attribute value.

◆ mutable_suspensionReasons()

client::JsonCppArray<string > google_reseller_api::Subscription::mutable_suspensionReasons ( )

inline

Gets a reference to a mutable value of the 'suspensionReasons' property.

Read: only field containing an enumerable of all the current suspension reasons for a subscription. It is possible for a subscription to have many concurrent, overlapping suspension reasons. A subscription's STATUS is SUSPENDED until all pending suspensions are removed.
include: .

PENDING_TOS_ACCEPTANCE: The customer has not logged in and accepted the G Suite Resold Terms of Services.
RENEWAL_WITH_TYPE_CANCEL: The customer's commitment ended and their service was cancelled at the end of their term.
RESELLER_INITIATED: A manual suspension invoked by a Reseller.
TRIAL_ENDED: The customer's trial expired without a plan selected.
OTHER: The customer is suspended for an internal Google reason (e.g. abuse or otherwise).

Returns: The result can be modified to change the attribute value.

◆ mutable_transferInfo()

SubscriptionTransferInfo google_reseller_api::Subscription::mutable_transferInfo ( )

inline

Gets a reference to a mutable value of the 'transferInfo' property.

Read-only transfer related information for the subscription. For more information, see retrieve transferable subscriptions for a customer.

Returns: The result can be modified to change the attribute value.

◆ mutable_trialSettings()

SubscriptionTrialSettings google_reseller_api::Subscription::mutable_trialSettings ( )

inline

Gets a reference to a mutable value of the 'trialSettings' property.

The G Suite annual commitment and flexible payment plans can be in a 30-day free trial. For more information, see the API concepts.

Returns: The result can be modified to change the attribute value.

◆ New()

Subscription * google_reseller_api::Subscription::New ( )

static

Creates a new default instance.

Returns: Ownership is passed back to the caller.

◆ set_billing_method()

void google_reseller_api::Subscription::set_billing_method ( const StringPiece & value )

inline

Change the 'billingMethod' attribute.

Read-only field that returns the current billing method for a subscription.

Parameters

[in] value The new value.

◆ set_creation_time()

void google_reseller_api::Subscription::set_creation_time ( int64 value )

inline

Change the 'creationTime' attribute.

The creationTime property is the date when subscription was created. It is in milliseconds using the Epoch format. See an example Epoch converter.

Parameters

[in] value The new value.

◆ set_customer_domain()

void google_reseller_api::Subscription::set_customer_domain ( const StringPiece & value )

inline

Change the 'customerDomain' attribute.

Primary domain name of the customer.

Parameters

[in] value The new value.

◆ set_customer_id()

void google_reseller_api::Subscription::set_customer_id ( const StringPiece & value )

inline

Change the 'customerId' attribute.

This property will always be returned in a response as the unique identifier generated by Google. In a request, this property can be either the primary domain or the unique identifier generated by Google.

Parameters

[in] value The new value.

◆ set_deal_code()

void google_reseller_api::Subscription::set_deal_code ( const StringPiece & value )

inline

Change the 'dealCode' attribute.

Google-issued code (100 char max) for discounted pricing on subscription plans. Deal code must be included in insert requests in order to receive discounted rate. This property is optional, regular pricing applies if left empty.

Parameters

[in] value The new value.

◆ set_kind()

void google_reseller_api::Subscription::set_kind ( const StringPiece & value )

inline

Change the 'kind' attribute.

Identifies the resource as a Subscription. Value: reseller::subscription.

Parameters

[in] value The new value.

◆ set_purchase_order_id()

void google_reseller_api::Subscription::set_purchase_order_id ( const StringPiece & value )

inline

Change the 'purchaseOrderId' attribute.

This is an optional property. This purchase order (PO) information is for resellers to use for their company tracking usage. If a purchaseOrderId value is given it appears in the API responses and shows up in the invoice. The property accepts up to 80 plain text characters.

Parameters

[in] value The new value.

◆ set_resource_ui_url()

void google_reseller_api::Subscription::set_resource_ui_url ( const StringPiece & value )

inline

Change the 'resourceUiUrl' attribute.

URL to customer's Subscriptions page in the Admin console. The read-only URL is generated by the API service. This is used if your client application requires the customer to complete a task using the Subscriptions page in the Admin console.

Parameters

[in] value The new value.

◆ set_sku_id()

void google_reseller_api::Subscription::set_sku_id ( const StringPiece & value )

inline

Change the 'skuId' attribute.

A required property. The skuId is a unique system identifier for a product's SKU assigned to a customer in the subscription. For products and SKUs available in this version of the API, see Product and SKU IDs.

Parameters

[in] value The new value.

◆ set_sku_name()

void google_reseller_api::Subscription::set_sku_name ( const StringPiece & value )

inline

Change the 'skuName' attribute.

Read-only external display name for a product's SKU assigned to a customer in the subscription. SKU names are subject to change at Google's discretion. For products and SKUs available in this version of the API, see Product and SKU IDs.

Parameters

[in] value The new value.

◆ set_status()

void google_reseller_api::Subscription::set_status ( const StringPiece & value )

inline

Change the 'status' attribute.

This is an optional property.

Parameters

[in] value The new value.

◆ set_subscription_id()

void google_reseller_api::Subscription::set_subscription_id ( const StringPiece & value )

inline

Change the 'subscriptionId' attribute.

The subscriptionId is the subscription identifier and is unique for each customer. This is a required property. Since a subscriptionId changes when a subscription is updated, we recommend not using this ID as a key for persistent data. Use the subscriptionId as described in retrieve all reseller subscriptions.

Parameters

[in] value The new value.

The documentation for this class was generated from the following files:

google/reseller_api/subscription.h
google/reseller_api/subscription.cc

Classes

Public Member Functions

Static Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ Subscription() [1/2]

◆ Subscription() [2/2]

◆ ~Subscription()

Member Function Documentation

◆ clear_billing_method()

◆ clear_creation_time()

◆ clear_customer_domain()

◆ clear_customer_id()

◆ clear_deal_code()

◆ clear_kind()

◆ clear_plan()

◆ clear_purchase_order_id()

◆ clear_renewal_settings()

◆ clear_resource_ui_url()

◆ clear_seats()

◆ clear_sku_id()

◆ clear_sku_name()

◆ clear_status()

◆ clear_subscription_id()

◆ clear_suspension_reasons()

◆ clear_transfer_info()

◆ clear_trial_settings()

◆ get_billing_method()

◆ get_creation_time()

◆ get_customer_domain()

◆ get_customer_id()

◆ get_deal_code()

◆ get_kind()

◆ get_plan()

◆ get_purchase_order_id()

◆ get_renewal_settings()

◆ get_resource_ui_url()

◆ get_seats()

◆ get_sku_id()

◆ get_sku_name()

◆ get_status()

◆ get_subscription_id()

◆ get_suspension_reasons()

◆ get_transfer_info()

◆ get_trial_settings()

◆ GetTypeName()

◆ has_billing_method()

◆ has_creation_time()

◆ has_customer_domain()

◆ has_customer_id()

◆ has_deal_code()

◆ has_kind()

◆ has_plan()

◆ has_purchase_order_id()

◆ has_renewal_settings()

◆ has_resource_ui_url()

◆ has_seats()

◆ has_sku_id()

◆ has_sku_name()

◆ has_status()

◆ has_subscription_id()

◆ has_suspension_reasons()

◆ has_transfer_info()

◆ has_trial_settings()

◆ mutable_plan()

◆ mutable_renewalSettings()

◆ mutable_seats()

◆ mutable_suspensionReasons()

◆ mutable_transferInfo()

◆ mutable_trialSettings()

◆ New()

◆ set_billing_method()

◆ set_creation_time()

◆ set_customer_domain()

◆ set_customer_id()

◆ set_deal_code()

◆ set_kind()

◆ set_purchase_order_id()

◆ set_resource_ui_url()

◆ set_sku_id()