Package com.stripe.param

Class ShippingRateCreateParams

java.lang.Object

com.stripe.net.ApiRequestParams

com.stripe.param.ShippingRateCreateParams

public class ShippingRateCreateParams
extends ApiRequestParams

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ShippingRateCreateParams.Builder
static class	ShippingRateCreateParams.DeliveryEstimate
static class	ShippingRateCreateParams.FixedAmount	Required. Must be greater than 0.
static enum	ShippingRateCreateParams.TaxBehavior	Specifies whether the rate is considered inclusive of taxes or exclusive of taxes.
static enum	ShippingRateCreateParams.Type

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 ShippingRateCreateParams.Builder	builder()
ShippingRateCreateParams.DeliveryEstimate	getDeliveryEstimate()	The estimated range for how long shipping will take, meant to be displayable to the customer.
String	getDisplayName()	Required. The name of the shipping rate, meant to be displayable to the customer.
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.
ShippingRateCreateParams.FixedAmount	getFixedAmount()	Describes a fixed amount to charge for shipping.
Map<String,String>	getMetadata()	Set of key-value pairs that you can attach to an object.
ShippingRateCreateParams.TaxBehavior	getTaxBehavior()	Specifies whether the rate is considered inclusive of taxes or exclusive of taxes.
String	getTaxCode()	A tax code ID.
ShippingRateCreateParams.Type	getType()	The type of calculation to use on the shipping rate.

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 ShippingRateCreateParams.Builder builder()

getDeliveryEstimate

public ShippingRateCreateParams.DeliveryEstimate getDeliveryEstimate()

The estimated range for how long shipping will take, meant to be displayable to the customer. This will appear on CheckoutSessions.

getDisplayName

public String getDisplayName()

Required. The name of the shipping rate, meant to be displayable to the customer. This will appear on CheckoutSessions.

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.

getFixedAmount

public ShippingRateCreateParams.FixedAmount getFixedAmount()

Describes a fixed amount to charge for shipping. Must be present if type is fixed_amount.

getMetadata

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

getTaxBehavior

public ShippingRateCreateParams.TaxBehavior getTaxBehavior()

Specifies whether the rate is considered inclusive of taxes or exclusive of taxes. One of inclusive, exclusive, or unspecified.

getTaxCode

public String getTaxCode()

A tax code ID. The Shipping tax code is txcd_92010001.

getType

public ShippingRateCreateParams.Type getType()

The type of calculation to use on the shipping rate. Can only be fixed_amount for now.