Package com.stripe.param.checkout

Class SessionCreateParams.ShippingOption.ShippingRateData.Builder

java.lang.Object

com.stripe.param.checkout.SessionCreateParams.ShippingOption.ShippingRateData.Builder

Enclosing class:

SessionCreateParams.ShippingOption.ShippingRateData

public static class SessionCreateParams.ShippingOption.ShippingRateData.Builder
extends Object

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
SessionCreateParams.ShippingOption.ShippingRateData	build()	Finalize and obtain parameter instance from this builder.
SessionCreateParams.ShippingOption.ShippingRateData.Builder	putAllExtraParam(Map<String,Object> map)	Add all map key/value pairs to `extraParams` map.
SessionCreateParams.ShippingOption.ShippingRateData.Builder	putAllMetadata(Map<String,String> map)	Add all map key/value pairs to `metadata` map.
SessionCreateParams.ShippingOption.ShippingRateData.Builder	putExtraParam(String key, Object value)	Add a key/value pair to `extraParams` map.
SessionCreateParams.ShippingOption.ShippingRateData.Builder	putMetadata(String key, String value)	Add a key/value pair to `metadata` map.
SessionCreateParams.ShippingOption.ShippingRateData.Builder	setDeliveryEstimate(SessionCreateParams.ShippingOption.ShippingRateData.DeliveryEstimate deliveryEstimate)	The estimated range for how long shipping will take, meant to be displayable to the customer.
SessionCreateParams.ShippingOption.ShippingRateData.Builder	setDisplayName(String displayName)	Required. The name of the shipping rate, meant to be displayable to the customer.
SessionCreateParams.ShippingOption.ShippingRateData.Builder	setFixedAmount(SessionCreateParams.ShippingOption.ShippingRateData.FixedAmount fixedAmount)	Describes a fixed amount to charge for shipping.
SessionCreateParams.ShippingOption.ShippingRateData.Builder	setTaxBehavior(SessionCreateParams.ShippingOption.ShippingRateData.TaxBehavior taxBehavior)	Specifies whether the rate is considered inclusive of taxes or exclusive of taxes.
SessionCreateParams.ShippingOption.ShippingRateData.Builder	setTaxCode(String taxCode)	A tax code ID.
SessionCreateParams.ShippingOption.ShippingRateData.Builder	setType(SessionCreateParams.ShippingOption.ShippingRateData.Type type)	The type of calculation to use on the shipping rate.

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder()

Method Details

build

public SessionCreateParams.ShippingOption.ShippingRateData build()

Finalize and obtain parameter instance from this builder.

setDeliveryEstimate

public SessionCreateParams.ShippingOption.ShippingRateData.Builder setDeliveryEstimate(SessionCreateParams.ShippingOption.ShippingRateData.DeliveryEstimate deliveryEstimate)

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

setDisplayName

public SessionCreateParams.ShippingOption.ShippingRateData.Builder setDisplayName(String displayName)

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

putExtraParam

public SessionCreateParams.ShippingOption.ShippingRateData.Builder putExtraParam(String key,
 Object value)

Add a key/value pair to `extraParams` map. A map is initialized for the first `put/putAll` call, and subsequent calls add additional key/value pairs to the original map. See SessionCreateParams.ShippingOption.ShippingRateData.extraParams for the field documentation.

putAllExtraParam

public SessionCreateParams.ShippingOption.ShippingRateData.Builder putAllExtraParam(Map<String,Object> map)

Add all map key/value pairs to `extraParams` map. A map is initialized for the first `put/putAll` call, and subsequent calls add additional key/value pairs to the original map. See SessionCreateParams.ShippingOption.ShippingRateData.extraParams for the field documentation.

setFixedAmount

public SessionCreateParams.ShippingOption.ShippingRateData.Builder setFixedAmount(SessionCreateParams.ShippingOption.ShippingRateData.FixedAmount fixedAmount)

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

putMetadata

public SessionCreateParams.ShippingOption.ShippingRateData.Builder putMetadata(String key,
 String value)

Add a key/value pair to `metadata` map. A map is initialized for the first `put/putAll` call, and subsequent calls add additional key/value pairs to the original map. See SessionCreateParams.ShippingOption.ShippingRateData.metadata for the field documentation.

putAllMetadata

public SessionCreateParams.ShippingOption.ShippingRateData.Builder putAllMetadata(Map<String,String> map)

Add all map key/value pairs to `metadata` map. A map is initialized for the first `put/putAll` call, and subsequent calls add additional key/value pairs to the original map. See SessionCreateParams.ShippingOption.ShippingRateData.metadata for the field documentation.

setTaxBehavior

public SessionCreateParams.ShippingOption.ShippingRateData.Builder setTaxBehavior(SessionCreateParams.ShippingOption.ShippingRateData.TaxBehavior taxBehavior)

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

setTaxCode

public SessionCreateParams.ShippingOption.ShippingRateData.Builder setTaxCode(String taxCode)

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

setType

public SessionCreateParams.ShippingOption.ShippingRateData.Builder setType(SessionCreateParams.ShippingOption.ShippingRateData.Type type)

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