Package com.stripe.param

Class PlanCreateParams.Tier

java.lang.Object

com.stripe.param.PlanCreateParams.Tier

Enclosing class:

PlanCreateParams

public static class PlanCreateParams.Tier
extends Object

A label that represents units of this product. When set, this will be included in customers' receipts, invoices, Checkout, and the customer portal.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	PlanCreateParams.Tier.Builder
static enum	PlanCreateParams.Tier.UpTo

Method Summary

Modifier and Type	Method	Description
static PlanCreateParams.Tier.Builder	builder()
Map<String,Object>	getExtraParams()	Map of extra parameters for custom features not available in this client library.
Long	getFlatAmount()	The flat billing amount for an entire tier, regardless of the number of units in the tier.
BigDecimal	getFlatAmountDecimal()	Same as flat_amount, but accepts a decimal value representing an integer in the minor units of the currency.
Long	getUnitAmount()	The per unit billing amount for each individual unit for which this tier applies.
BigDecimal	getUnitAmountDecimal()	Same as unit_amount, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places.
Object	getUpTo()	Required. Specifies the upper bound of this tier.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

builder

public static PlanCreateParams.Tier.Builder builder()

getExtraParams

public Map<String,Object> getExtraParams()

Map of extra parameters for custom features not available in this client library. The content in this map is not serialized under this field's @SerializedName value. Instead, each key/value pair is serialized as if the key is a root-level field (serialized) name in this param object. Effectively, this map is flattened to its parent instance.

getFlatAmount

public Long getFlatAmount()

The flat billing amount for an entire tier, regardless of the number of units in the tier.

getFlatAmountDecimal

public BigDecimal getFlatAmountDecimal()

Same as flat_amount, but accepts a decimal value representing an integer in the minor units of the currency. Only one of flat_amount and flat_amount_decimal can be set.

getUnitAmount

public Long getUnitAmount()

The per unit billing amount for each individual unit for which this tier applies.

getUnitAmountDecimal

public BigDecimal getUnitAmountDecimal()

Same as unit_amount, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of unit_amount and unit_amount_decimal can be set.

getUpTo

public Object getUpTo()

Required. Specifies the upper bound of this tier. The lower bound of a tier is the upper bound of the previous tier adding one. Use inf to define a fallback tier.