Package com.stripe.param
Class PlanCreateParams
- java.lang.Object
-
- com.stripe.net.ApiRequestParams
-
- com.stripe.param.PlanCreateParams
-
public class PlanCreateParams extends ApiRequestParams
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
PlanCreateParams.AggregateUsage
static class
PlanCreateParams.BillingScheme
static class
PlanCreateParams.Builder
static class
PlanCreateParams.Interval
static class
PlanCreateParams.Product
static class
PlanCreateParams.Tier
A label that represents units of this product in Stripe and on customers’ receipts and invoices.static class
PlanCreateParams.TiersMode
static class
PlanCreateParams.TransformUsage
static class
PlanCreateParams.UsageType
-
Nested classes/interfaces inherited from class com.stripe.net.ApiRequestParams
ApiRequestParams.EnumParam
-
-
Field Summary
-
Fields inherited from class com.stripe.net.ApiRequestParams
EXTRA_PARAMS_KEY
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static PlanCreateParams.Builder
builder()
java.lang.Boolean
getActive()
Whether the plan is currently available for new subscriptions.PlanCreateParams.AggregateUsage
getAggregateUsage()
Specifies a usage aggregation strategy for plans ofusage_type=metered
.java.lang.Long
getAmount()
A positive integer in %s (or 0 for a free plan) representing how much to charge on a recurring basis.java.math.BigDecimal
getAmountDecimal()
Same asamount
, but accepts a decimal value with at most 12 decimal places.PlanCreateParams.BillingScheme
getBillingScheme()
Describes how to compute the price per period.java.lang.String
getCurrency()
Three-letter ISO currency code, in lowercase.java.util.List<java.lang.String>
getExpand()
Specifies which fields in the response should be expanded.java.util.Map<java.lang.String,java.lang.Object>
getExtraParams()
Map of extra parameters for custom features not available in this client library.java.lang.String
getId()
An identifier randomly generated by Stripe.PlanCreateParams.Interval
getInterval()
Specifies billing frequency.java.lang.Long
getIntervalCount()
The number of intervals between subscription billings.java.lang.Object
getMetadata()
Set of key-value pairs that you can attach to an object.java.lang.String
getNickname()
A brief description of the plan, hidden from customers.java.lang.Object
getProduct()
java.util.List<PlanCreateParams.Tier>
getTiers()
Each element represents a pricing tier.PlanCreateParams.TiersMode
getTiersMode()
Defines if the tiering price should begraduated
orvolume
based.PlanCreateParams.TransformUsage
getTransformUsage()
Apply a transformation to the reported usage or set quantity before computing the billed price.java.lang.Long
getTrialPeriodDays()
Default number of trial days when subscribing a customer to this plan usingtrial_from_plan=true
.PlanCreateParams.UsageType
getUsageType()
Configures how the quantity per period should be determined.-
Methods inherited from class com.stripe.net.ApiRequestParams
toMap
-
-
-
-
Method Detail
-
builder
public static PlanCreateParams.Builder builder()
-
getActive
public java.lang.Boolean getActive()
Whether the plan is currently available for new subscriptions. Defaults totrue
.
-
getAggregateUsage
public PlanCreateParams.AggregateUsage getAggregateUsage()
Specifies a usage aggregation strategy for plans ofusage_type=metered
. Allowed values aresum
for summing up all usage during a period,last_during_period
for using the last usage record reported within a period,last_ever
for using the last usage record ever (across period bounds) ormax
which uses the usage record with the maximum reported usage during a period. Defaults tosum
.
-
getAmount
public java.lang.Long getAmount()
A positive integer in %s (or 0 for a free plan) representing how much to charge on a recurring basis.
-
getAmountDecimal
public java.math.BigDecimal getAmountDecimal()
Same asamount
, but accepts a decimal value with at most 12 decimal places. Only one ofamount
andamount_decimal
can be set.
-
getBillingScheme
public PlanCreateParams.BillingScheme getBillingScheme()
Describes how to compute the price per period. Eitherper_unit
ortiered
.per_unit
indicates that the fixed amount (specified inamount
) will be charged per unit inquantity
(for plans withusage_type=licensed
), or per unit of total usage (for plans withusage_type=metered
).tiered
indicates that the unit pricing will be computed using a tiering strategy as defined using thetiers
andtiers_mode
attributes.
-
getCurrency
public java.lang.String getCurrency()
Three-letter ISO currency code, in lowercase. Must be a supported currency.
-
getExpand
public java.util.List<java.lang.String> getExpand()
Specifies which fields in the response should be expanded.
-
getExtraParams
public java.util.Map<java.lang.String,java.lang.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.
-
getId
public java.lang.String getId()
An identifier randomly generated by Stripe. Used to identify this plan when subscribing a customer. You can optionally override this ID, but the ID must be unique across all plans in your Stripe account. You can, however, use the same plan ID in both live and test modes.
-
getInterval
public PlanCreateParams.Interval getInterval()
Specifies billing frequency. Eitherday
,week
,month
oryear
.
-
getIntervalCount
public java.lang.Long getIntervalCount()
The number of intervals between subscription billings. For example,interval=month
andinterval_count=3
bills every 3 months. Maximum of one year interval allowed (1 year, 12 months, or 52 weeks).
-
getMetadata
public java.lang.Object getMetadata()
Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value tometadata
.
-
getNickname
public java.lang.String getNickname()
A brief description of the plan, hidden from customers.
-
getProduct
public java.lang.Object getProduct()
-
getTiers
public java.util.List<PlanCreateParams.Tier> getTiers()
Each element represents a pricing tier. This parameter requiresbilling_scheme
to be set totiered
. See also the documentation forbilling_scheme
.
-
getTiersMode
public PlanCreateParams.TiersMode getTiersMode()
Defines if the tiering price should begraduated
orvolume
based. Involume
-based tiering, the maximum quantity within a period determines the per unit price, ingraduated
tiering pricing can successively change as the quantity grows.
-
getTransformUsage
public PlanCreateParams.TransformUsage getTransformUsage()
Apply a transformation to the reported usage or set quantity before computing the billed price. Cannot be combined withtiers
.
-
getTrialPeriodDays
public java.lang.Long getTrialPeriodDays()
Default number of trial days when subscribing a customer to this plan usingtrial_from_plan=true
.
-
getUsageType
public PlanCreateParams.UsageType getUsageType()
Configures how the quantity per period should be determined. Can be eithermetered
orlicensed
.licensed
automatically bills thequantity
set when adding it to a subscription.metered
aggregates the total usage based on usage records. Defaults tolicensed
.
-
-