Package com.stripe.param
Class PriceCreateParams
- java.lang.Object
-
- com.stripe.net.ApiRequestParams
-
- com.stripe.param.PriceCreateParams
-
public class PriceCreateParams extends ApiRequestParams
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
PriceCreateParams.BillingScheme
static class
PriceCreateParams.Builder
static class
PriceCreateParams.ProductData
static class
PriceCreateParams.Recurring
A label that represents units of this product in Stripe and on customers’ receipts and invoices.static class
PriceCreateParams.TaxBehavior
static class
PriceCreateParams.Tier
static class
PriceCreateParams.TiersMode
static class
PriceCreateParams.TransformQuantity
-
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 PriceCreateParams.Builder
builder()
java.lang.Boolean
getActive()
Whether the price can be used for new purchases.PriceCreateParams.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
getLookupKey()
A lookup key used to retrieve prices dynamically from a static string.java.util.Map<java.lang.String,java.lang.String>
getMetadata()
Set of key-value pairs that you can attach to an object.java.lang.String
getNickname()
A brief description of the price, hidden from customers.java.lang.String
getProduct()
The ID of the product that this price will belong to.PriceCreateParams.ProductData
getProductData()
These fields can be used to create a new product that this price will belong to.PriceCreateParams.Recurring
getRecurring()
The recurring components of a price such asinterval
andusage_type
.PriceCreateParams.TaxBehavior
getTaxBehavior()
Specifies whether the price is considered inclusive of taxes or exclusive of taxes.java.util.List<PriceCreateParams.Tier>
getTiers()
Each element represents a pricing tier.PriceCreateParams.TiersMode
getTiersMode()
Defines if the tiering price should begraduated
orvolume
based.java.lang.Boolean
getTransferLookupKey()
If set to true, will atomically remove the lookup key from the existing price, and assign it to this price.PriceCreateParams.TransformQuantity
getTransformQuantity()
Apply a transformation to the reported usage or set quantity before computing the billed price.java.lang.Long
getUnitAmount()
A positive integer in %s (or 0 for a free price) representing how much to charge.java.math.BigDecimal
getUnitAmountDecimal()
Same asunit_amount
, but accepts a decimal value in %s with at most 12 decimal places.-
Methods inherited from class com.stripe.net.ApiRequestParams
toMap
-
-
-
-
Method Detail
-
builder
public static PriceCreateParams.Builder builder()
-
getActive
public java.lang.Boolean getActive()
Whether the price can be used for new purchases. Defaults totrue
.
-
getBillingScheme
public PriceCreateParams.BillingScheme getBillingScheme()
Describes how to compute the price per period. Eitherper_unit
ortiered
.per_unit
indicates that the fixed amount (specified inunit_amount
orunit_amount_decimal
) will be charged per unit inquantity
(for prices withusage_type=licensed
), or per unit of total usage (for prices 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.
-
getLookupKey
public java.lang.String getLookupKey()
A lookup key used to retrieve prices dynamically from a static string. This may be up to 200 characters.
-
getMetadata
public java.util.Map<java.lang.String,java.lang.String> 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 price, hidden from customers.
-
getProduct
public java.lang.String getProduct()
The ID of the product that this price will belong to.
-
getProductData
public PriceCreateParams.ProductData getProductData()
These fields can be used to create a new product that this price will belong to.
-
getRecurring
public PriceCreateParams.Recurring getRecurring()
The recurring components of a price such asinterval
andusage_type
.
-
getTaxBehavior
public PriceCreateParams.TaxBehavior getTaxBehavior()
Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One ofinclusive
,exclusive
, orunspecified
. Once specified as eitherinclusive
orexclusive
, it cannot be changed.
-
getTiers
public java.util.List<PriceCreateParams.Tier> getTiers()
Each element represents a pricing tier. This parameter requiresbilling_scheme
to be set totiered
. See also the documentation forbilling_scheme
.
-
getTiersMode
public PriceCreateParams.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.
-
getTransferLookupKey
public java.lang.Boolean getTransferLookupKey()
If set to true, will atomically remove the lookup key from the existing price, and assign it to this price.
-
getTransformQuantity
public PriceCreateParams.TransformQuantity getTransformQuantity()
Apply a transformation to the reported usage or set quantity before computing the billed price. Cannot be combined withtiers
.
-
getUnitAmount
public java.lang.Long getUnitAmount()
A positive integer in %s (or 0 for a free price) representing how much to charge.
-
getUnitAmountDecimal
public java.math.BigDecimal getUnitAmountDecimal()
Same asunit_amount
, but accepts a decimal value in %s with at most 12 decimal places. Only one ofunit_amount
andunit_amount_decimal
can be set.
-
-