Google Cloud Commerce Producer V1beta Client - Class Commitment (0.2.0)

Reference documentation and code samples for the Google Cloud Commerce Producer V1beta Client class Commitment.

The price configurations for the commitment based subscriptions.

Generated from protobuf message google.cloud.commerceproducer.v1beta.PrivateOffer.SingleProductOffer.PriceModel.Commitment

Namespace

Google \ Cloud \ CommerceProducer \ V1beta \ PrivateOffer \ SingleProductOffer \ PriceModel

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ commitment_amount Google\Type\Money

Optional. The commitment balance that the customer will receive. Value cannot be negative. The currency must be "USD" and precision is limited to cents. Must be present to publish the offer, if the parent message is set. The maximum allowed value is 1,000,000,000 USD. If the current offer amends a private offer where the term has not ended, and if the field single_product_offer.standard_interval_price.price_model.commitment.commitment_amount is set on both the current offer and the amended private offer, then the commitment amount must be equal or higher on the current offer, compared to the amended private offer.
↳ discount_percent Google\Type\Decimal

Optional. The discount percent on commitment_amount. For example, 10 means a discount of 10%. If the original commitment_amount is $100 then the discounted amount will be $90. The customer is charged $90 and receives $100 in credits. All reported usage will be charged at the standard price. If this field is set, the price_model.usage must be unset. A private offer can apply a discount to all usage or to a usage commitment, but not both. Must be between 0 and 100 inclusive, with precision up to 2 decimal places. If this field is set, then the allowed pattern for 'value' is ^([0-9]{1,2}(\\.\\d{1,2})?|100(\\.0{1,2})?)$. Examples of valid values: "0", "100.0", "12.34", "40.0". Example of invalid values: ".3", "-1", "100.1", "12.345", "+12", "". Must be present to publish the offer.
↳ additional_credit Google\Type\Money

Optional. Additional credit granted to the customer. Additional credits are only supported for custom interval offers. Equivalent behavior can be achieved for standard interval offers by varying the commitment_amount and discount_percent. Value cannot be negative. The currency must be "USD" and precision is limited to cents. The maximum allowed value is 1,000,000 USD.
↳ discard_previous_credit_balance bool

Optional. Whether to discard the previous credit balance when the associated installment starts. If not set, the previous credit balance will be rolled over to the current installment. If there are no previous installments, then the value of this field will not matter - since it has no effect when no credits exist.

getCommitmentAmount

Optional. The commitment balance that the customer will receive.

Value cannot be negative. The currency must be "USD" and precision is limited to cents. Must be present to publish the offer, if the parent message is set. The maximum allowed value is 1,000,000,000 USD. If the current offer amends a private offer where the term has not ended, and if the field single_product_offer.standard_interval_price.price_model.commitment.commitment_amount is set on both the current offer and the amended private offer, then the commitment amount must be equal or higher on the current offer, compared to the amended private offer.

Returns
Type Description
Google\Type\Money|null

hasCommitmentAmount

clearCommitmentAmount

setCommitmentAmount

Optional. The commitment balance that the customer will receive.

Value cannot be negative. The currency must be "USD" and precision is limited to cents. Must be present to publish the offer, if the parent message is set. The maximum allowed value is 1,000,000,000 USD. If the current offer amends a private offer where the term has not ended, and if the field single_product_offer.standard_interval_price.price_model.commitment.commitment_amount is set on both the current offer and the amended private offer, then the commitment amount must be equal or higher on the current offer, compared to the amended private offer.

Parameter
Name Description
var Google\Type\Money
Returns
Type Description
$this

getDiscountPercent

Optional. The discount percent on commitment_amount.

For example, 10 means a discount of 10%. If the original commitment_amount is $100 then the discounted amount will be $90. The customer is charged $90 and receives $100 in credits. All reported usage will be charged at the standard price. If this field is set, the price_model.usage must be unset. A private offer can apply a discount to all usage or to a usage commitment, but not both. Must be between 0 and 100 inclusive, with precision up to 2 decimal places. If this field is set, then the allowed pattern for 'value' is ^([0-9]{1,2}(\\.\\d{1,2})?|100(\\.0{1,2})?)$. Examples of valid values: "0", "100.0", "12.34", "40.0". Example of invalid values: ".3", "-1", "100.1", "12.345", "+12", "". Must be present to publish the offer.

Returns
Type Description
Google\Type\Decimal|null

hasDiscountPercent

clearDiscountPercent

setDiscountPercent

Optional. The discount percent on commitment_amount.

For example, 10 means a discount of 10%. If the original commitment_amount is $100 then the discounted amount will be $90. The customer is charged $90 and receives $100 in credits. All reported usage will be charged at the standard price. If this field is set, the price_model.usage must be unset. A private offer can apply a discount to all usage or to a usage commitment, but not both. Must be between 0 and 100 inclusive, with precision up to 2 decimal places. If this field is set, then the allowed pattern for 'value' is ^([0-9]{1,2}(\\.\\d{1,2})?|100(\\.0{1,2})?)$. Examples of valid values: "0", "100.0", "12.34", "40.0". Example of invalid values: ".3", "-1", "100.1", "12.345", "+12", "". Must be present to publish the offer.

Parameter
Name Description
var Google\Type\Decimal
Returns
Type Description
$this

getAdditionalCredit

Optional. Additional credit granted to the customer.

Additional credits are only supported for custom interval offers. Equivalent behavior can be achieved for standard interval offers by varying the commitment_amount and discount_percent. Value cannot be negative. The currency must be "USD" and precision is limited to cents. The maximum allowed value is 1,000,000 USD.

Returns
Type Description
Google\Type\Money|null

hasAdditionalCredit

clearAdditionalCredit

setAdditionalCredit

Optional. Additional credit granted to the customer.

Additional credits are only supported for custom interval offers. Equivalent behavior can be achieved for standard interval offers by varying the commitment_amount and discount_percent. Value cannot be negative. The currency must be "USD" and precision is limited to cents. The maximum allowed value is 1,000,000 USD.

Parameter
Name Description
var Google\Type\Money
Returns
Type Description
$this

getDiscardPreviousCreditBalance

Optional. Whether to discard the previous credit balance when the associated installment starts. If not set, the previous credit balance will be rolled over to the current installment.

If there are no previous installments, then the value of this field will not matter - since it has no effect when no credits exist.

Returns
Type Description
bool

setDiscardPreviousCreditBalance

Optional. Whether to discard the previous credit balance when the associated installment starts. If not set, the previous credit balance will be rolled over to the current installment.

If there are no previous installments, then the value of this field will not matter - since it has no effect when no credits exist.

Parameter
Name Description
var bool
Returns
Type Description
$this