public static interface PrivateOffer.SingleProductOffer.PriceModel.CommitmentOrBuilder extends MessageOrBuilderImplements
MessageOrBuilderMethods
getAdditionalCredit()
public abstract Money 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.
.google.type.Money additional_credit = 3 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
com.google.type.Money |
The additionalCredit. |
getAdditionalCreditOrBuilder()
public abstract MoneyOrBuilder getAdditionalCreditOrBuilder() 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.
.google.type.Money additional_credit = 3 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
com.google.type.MoneyOrBuilder |
|
getCommitmentAmount()
public abstract Money 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.
.google.type.Money commitment_amount = 1 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
com.google.type.Money |
The commitmentAmount. |
getCommitmentAmountOrBuilder()
public abstract MoneyOrBuilder getCommitmentAmountOrBuilder()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.
.google.type.Money commitment_amount = 1 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
com.google.type.MoneyOrBuilder |
|
getDiscardPreviousCreditBalance()
public abstract boolean 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.
bool discard_previous_credit_balance = 4 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
boolean |
The discardPreviousCreditBalance. |
getDiscountPercent()
public abstract Decimal 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.
.google.type.Decimal discount_percent = 2 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
com.google.type.Decimal |
The discountPercent. |
getDiscountPercentOrBuilder()
public abstract DecimalOrBuilder getDiscountPercentOrBuilder() 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.
.google.type.Decimal discount_percent = 2 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
com.google.type.DecimalOrBuilder |
|
hasAdditionalCredit()
public abstract boolean hasAdditionalCredit() 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.
.google.type.Money additional_credit = 3 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the additionalCredit field is set. |
hasCommitmentAmount()
public abstract boolean hasCommitmentAmount()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.
.google.type.Money commitment_amount = 1 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the commitmentAmount field is set. |
hasDiscountPercent()
public abstract boolean hasDiscountPercent() 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.
.google.type.Decimal discount_percent = 2 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the discountPercent field is set. |