Package com.stripe.param
Class PriceUpdateParams
- java.lang.Object
-
- com.stripe.net.ApiRequestParams
-
- com.stripe.param.PriceUpdateParams
-
public class PriceUpdateParams extends ApiRequestParams
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
PriceUpdateParams.Builder
static class
PriceUpdateParams.Recurring
static class
PriceUpdateParams.TaxBehavior
Default number of trial days when subscribing a customer to this plan usingtrial_from_plan=true
.-
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 PriceUpdateParams.Builder
builder()
java.lang.Boolean
getActive()
Whether the price can be used for new purchases.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.Object
getLookupKey()
A lookup key used to retrieve prices dynamically from a static string.java.lang.Object
getMetadata()
Set of key-value pairs that you can attach to an object.java.lang.Object
getNickname()
A brief description of the price, hidden from customers.java.lang.Object
getRecurring()
The recurring components of a price such asinterval
andusage_type
.PriceUpdateParams.TaxBehavior
getTaxBehavior()
Specifies whether the price is considered inclusive of taxes or exclusive of taxes.java.lang.Boolean
getTransferLookupKey()
If set to true, will atomically remove the lookup key from the existing price, and assign it to this price.-
Methods inherited from class com.stripe.net.ApiRequestParams
toMap
-
-
-
-
Method Detail
-
builder
public static PriceUpdateParams.Builder builder()
-
getActive
public java.lang.Boolean getActive()
Whether the price can be used for new purchases. Defaults totrue
.
-
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.Object getLookupKey()
A lookup key used to retrieve prices dynamically from a static string. This may be up to 200 characters.
-
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.Object getNickname()
A brief description of the price, hidden from customers.
-
getRecurring
public java.lang.Object getRecurring()
The recurring components of a price such asinterval
andusage_type
.
-
getTaxBehavior
public PriceUpdateParams.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.
-
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.
-
-