#include <subscription.h>
Classes | |
| class | SubscriptionPlanCommitmentInterval |
Public Member Functions | |
| SubscriptionPlan (const Json::Value &storage) | |
| SubscriptionPlan (Json::Value *storage) | |
| virtual | ~SubscriptionPlan () |
| const StringPiece | GetTypeName () const |
| bool | has_commitment_interval () const |
| void | clear_commitment_interval () |
| const SubscriptionPlanCommitmentInterval | get_commitment_interval () const |
| SubscriptionPlanCommitmentInterval | mutable_commitmentInterval () |
| bool | has_is_commitment_plan () const |
| void | clear_is_commitment_plan () |
| bool | get_is_commitment_plan () const |
| void | set_is_commitment_plan (bool value) |
| bool | has_plan_name () const |
| void | clear_plan_name () |
| const StringPiece | get_plan_name () const |
| void | set_plan_name (const StringPiece &value) |
Static Public Member Functions | |
| static SubscriptionPlan * | New () |
Detailed Description
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.
Constructor & Destructor Documentation
◆ SubscriptionPlan() [1/2]
|
explicit |
Standard constructor for an immutable data object instance.
- Parameters
-
[in] storage The underlying data storage for this instance.
◆ SubscriptionPlan() [2/2]
|
explicit |
Standard constructor for a mutable data object instance.
- Parameters
-
[in] storage The underlying data storage for this instance.
◆ ~SubscriptionPlan()
|
virtual |
Standard destructor.
Member Function Documentation
◆ clear_commitment_interval()
|
inline |
Clears the 'commitmentInterval' attribute.
◆ clear_is_commitment_plan()
|
inline |
Clears the 'isCommitmentPlan' attribute.
◆ clear_plan_name()
|
inline |
Clears the 'planName' attribute.
◆ get_commitment_interval()
|
inline |
Get a reference to the value of the 'commitmentInterval' attribute.
◆ get_is_commitment_plan()
|
inline |
Get the value of the 'isCommitmentPlan' attribute.
◆ get_plan_name()
|
inline |
Get the value of the 'planName' attribute.
◆ GetTypeName()
|
inline |
Returns a string denoting the type of this data object.
- Returns
google_reseller_api::SubscriptionPlan
◆ has_commitment_interval()
|
inline |
Determine if the 'commitmentInterval' attribute was set.
- Returns
- true if the '
commitmentInterval' attribute was set.
◆ has_is_commitment_plan()
|
inline |
Determine if the 'isCommitmentPlan' attribute was set.
- Returns
- true if the '
isCommitmentPlan' attribute was set.
◆ has_plan_name()
|
inline |
Determine if the 'planName' attribute was set.
- Returns
- true if the '
planName' attribute was set.
◆ mutable_commitmentInterval()
|
inline |
Gets a reference to a mutable value of the 'commitmentInterval' property.
In this version of the API, annual commitment plan's interval is one year. Note: When billingMethod value is OFFLINE, the subscription property object plan.commitmentInterval is omitted in all API responses.
- Returns
- The result can be modified to change the attribute value.
◆ New()
|
static |
Creates a new default instance.
- Returns
- Ownership is passed back to the caller.
◆ set_is_commitment_plan()
|
inline |
Change the 'isCommitmentPlan' attribute.
The isCommitmentPlan property's boolean value identifies the plan as an annual commitment plan:
- true — The subscription's plan is an annual commitment plan.
- false — The plan is not an annual commitment plan.
- Parameters
-
[in] value The new value.
◆ set_plan_name()
|
inline |
Change the 'planName' attribute.
The planName property is required. This is the name of the subscription's plan. For more information about the Google payment plans, see the API concepts.
Possible values are:
- ANNUAL_MONTHLY_PAY — The annual commitment plan with monthly payments. Caution: ANNUAL_MONTHLY_PAY is returned as ANNUAL in all API responses.
- ANNUAL_YEARLY_PAY — The annual commitment plan with yearly payments
- FLEXIBLE — The flexible plan
- TRIAL — The 30-day free trial plan. A subscription in trial will be suspended after the 30th free day if no payment plan is assigned. Calling changePlan will assign a payment plan to a trial but will not activate the plan. A trial will automatically begin its assigned payment plan after its 30th free day or immediately after calling startPaidService.
- FREE — The free plan is exclusive to the Cloud Identity SKU and does not incur any billing.
- 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
