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.CurrencyOption
static enum	PriceUpdateParams.TaxBehavior

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

Modifier and Type	Method	Description
static PriceUpdateParams.Builder	builder()
Boolean	getActive()	Whether the price can be used for new purchases.
Object	getCurrencyOptions()	Prices defined in each available currency option.
List<String>	getExpand()	Specifies which fields in the response should be expanded.
Map<String,Object>	getExtraParams()	Map of extra parameters for custom features not available in this client library.
Object	getLookupKey()	A lookup key used to retrieve prices dynamically from a static string.
Object	getMetadata()	Set of key-value pairs that you can attach to an object.
Object	getNickname()	A brief description of the price, hidden from customers.
PriceUpdateParams.TaxBehavior	getTaxBehavior()	Only required if a default tax behavior was not provided in the Stripe Tax settings.
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

paramsToMap, toMap

Methods inherited from class java.lang.Object

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

Method Details

builder

public static PriceUpdateParams.Builder builder()

getActive

public Boolean getActive()

Whether the price can be used for new purchases. Defaults to true.

getCurrencyOptions

public Object getCurrencyOptions()

Prices defined in each available currency option. Each key must be a three-letter ISO currency code and a supported currency.

getExpand

public List<String> getExpand()

Specifies which fields in the response should be expanded.

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.

getLookupKey

public Object getLookupKey()

A lookup key used to retrieve prices dynamically from a static string. This may be up to 200 characters.

getMetadata

public 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 to metadata.

getNickname

public Object getNickname()

A brief description of the price, hidden from customers.

getTaxBehavior

public PriceUpdateParams.TaxBehavior getTaxBehavior()

Only required if a default tax behavior was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of inclusive, exclusive, or unspecified. Once specified as either inclusive or exclusive, it cannot be changed.

getTransferLookupKey

public Boolean getTransferLookupKey()

If set to true, will atomically remove the lookup key from the existing price, and assign it to this price.