Package com.stripe.model

Class ShippingRate

java.lang.Object

com.stripe.model.StripeObject

com.stripe.net.ApiResource

com.stripe.model.ShippingRate

All Implemented Interfaces:

HasId, MetadataStore<ShippingRate>, StripeObjectInterface

public class ShippingRate
extends ApiResource
implements HasId, MetadataStore<ShippingRate>

Shipping rates describe the price of shipping presented to your customers and can be applied to Checkout Sessions and Orders to collect shipping costs.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ShippingRate.CurrencyOption
static class	ShippingRate.DeliveryEstimate
static class	ShippingRate.FixedAmount	Must be greater than 0.

Nested classes/interfaces inherited from class com.stripe.net.ApiResource

ApiResource.RequestMethod

Field Summary

Fields inherited from class com.stripe.net.ApiResource

CHARSET, GSON

Fields inherited from class com.stripe.model.StripeObject

PRETTY_PRINT_GSON

Constructor Summary

Constructors

Constructor	Description
ShippingRate()

Method Summary

Modifier and Type	Method	Description
protected boolean	canEqual(Object other)
static ShippingRate	create(ShippingRateCreateParams params)	Creates a new shipping rate object.
static ShippingRate	create(ShippingRateCreateParams params, RequestOptions options)	Creates a new shipping rate object.
static ShippingRate	create(Map<String,Object> params)	Creates a new shipping rate object.
static ShippingRate	create(Map<String,Object> params, RequestOptions options)	Creates a new shipping rate object.
boolean	equals(Object o)
Boolean	getActive()	Whether the shipping rate can be used for new purchases.
Long	getCreated()	Time at which the object was created.
ShippingRate.DeliveryEstimate	getDeliveryEstimate()	The estimated range for how long shipping will take, meant to be displayable to the customer.
String	getDisplayName()	The name of the shipping rate, meant to be displayable to the customer.
ShippingRate.FixedAmount	getFixedAmount()
String	getId()	Unique identifier for the object.
Boolean	getLivemode()	Has the value true if the object exists in live mode or the value false if the object exists in test mode.
Map<String,String>	getMetadata()	Set of key-value pairs that you can attach to an object.
String	getObject()	String representing the object's type.
String	getTaxBehavior()	Specifies whether the rate is considered inclusive of taxes or exclusive of taxes.
String	getTaxCode()	Get ID of expandable taxCode object.
TaxCode	getTaxCodeObject()	Get expanded taxCode.
String	getType()	The type of calculation to use on the shipping rate.
int	hashCode()
static ShippingRateCollection	list(ShippingRateListParams params)	Returns a list of your shipping rates.
static ShippingRateCollection	list(ShippingRateListParams params, RequestOptions options)	Returns a list of your shipping rates.
static ShippingRateCollection	list(Map<String,Object> params)	Returns a list of your shipping rates.
static ShippingRateCollection	list(Map<String,Object> params, RequestOptions options)	Returns a list of your shipping rates.
static ShippingRate	retrieve(String shippingRateToken)	Returns the shipping rate object with the given ID.
static ShippingRate	retrieve(String shippingRateToken, RequestOptions options)	Returns the shipping rate object with the given ID.
static ShippingRate	retrieve(String shippingRateToken, ShippingRateRetrieveParams params, RequestOptions options)	Returns the shipping rate object with the given ID.
static ShippingRate	retrieve(String shippingRateToken, Map<String,Object> params, RequestOptions options)	Returns the shipping rate object with the given ID.
void	setActive(Boolean active)	Whether the shipping rate can be used for new purchases.
void	setCreated(Long created)	Time at which the object was created.
void	setDeliveryEstimate(ShippingRate.DeliveryEstimate deliveryEstimate)	The estimated range for how long shipping will take, meant to be displayable to the customer.
void	setDisplayName(String displayName)	The name of the shipping rate, meant to be displayable to the customer.
void	setFixedAmount(ShippingRate.FixedAmount fixedAmount)
void	setId(String id)	Unique identifier for the object.
void	setLivemode(Boolean livemode)	Has the value true if the object exists in live mode or the value false if the object exists in test mode.
void	setMetadata(Map<String,String> metadata)	Set of key-value pairs that you can attach to an object.
void	setObject(String object)	String representing the object's type.
void	setTaxBehavior(String taxBehavior)	Specifies whether the rate is considered inclusive of taxes or exclusive of taxes.
void	setTaxCode(String id)
void	setTaxCodeObject(TaxCode expandableObject)
void	setType(String type)	The type of calculation to use on the shipping rate.
ShippingRate	update(ShippingRateUpdateParams params)	Updates an existing shipping rate object.
ShippingRate	update(ShippingRateUpdateParams params, RequestOptions options)	Updates an existing shipping rate object.
ShippingRate	update(Map<String,Object> params)	Updates an existing shipping rate object.
ShippingRate	update(Map<String,Object> params, RequestOptions options)	Updates an existing shipping rate object.

Methods inherited from class com.stripe.net.ApiResource

checkNullTypedParams, classUrl, classUrl, instanceUrl, instanceUrl, request, request, requestCollection, requestCollection, requestSearchResult, requestSearchResult, requestStream, requestStream, setExpandableFieldId, setStripeResponseGetter, singleClassUrl, singleClassUrl, subresourceUrl, urlEncode, urlEncodeId

Methods inherited from class com.stripe.model.StripeObject

equals, getLastResponse, getRawJsonObject, setLastResponse, toJson, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

ShippingRate

public ShippingRate()

Method Details

getTaxCode

public String getTaxCode()

Get ID of expandable taxCode object.

setTaxCode

public void setTaxCode(String id)

getTaxCodeObject

public TaxCode getTaxCodeObject()

Get expanded taxCode.

setTaxCodeObject

public void setTaxCodeObject(TaxCode expandableObject)

create

public static ShippingRate create(Map<String,Object> params)
                           throws StripeException

Creates a new shipping rate object.

Throws:

StripeException

create

public static ShippingRate create(Map<String,Object> params,
 RequestOptions options)
                           throws StripeException

Creates a new shipping rate object.

Throws:

StripeException

create

public static ShippingRate create(ShippingRateCreateParams params)
                           throws StripeException

Creates a new shipping rate object.

Throws:

StripeException

create

public static ShippingRate create(ShippingRateCreateParams params,
 RequestOptions options)
                           throws StripeException

Creates a new shipping rate object.

Throws:

StripeException

list

public static ShippingRateCollection list(Map<String,Object> params)
                                   throws StripeException

Returns a list of your shipping rates.

Throws:

StripeException

list

public static ShippingRateCollection list(Map<String,Object> params,
 RequestOptions options)
                                   throws StripeException

Returns a list of your shipping rates.

Throws:

StripeException

list

public static ShippingRateCollection list(ShippingRateListParams params)
                                   throws StripeException

Returns a list of your shipping rates.

Throws:

StripeException

list

public static ShippingRateCollection list(ShippingRateListParams params,
 RequestOptions options)
                                   throws StripeException

Returns a list of your shipping rates.

Throws:

StripeException

retrieve

public static ShippingRate retrieve(String shippingRateToken)
                             throws StripeException

Returns the shipping rate object with the given ID.

Throws:

StripeException

retrieve

public static ShippingRate retrieve(String shippingRateToken,
 RequestOptions options)
                             throws StripeException

Returns the shipping rate object with the given ID.

Throws:

StripeException

retrieve

public static ShippingRate retrieve(String shippingRateToken,
 Map<String,Object> params,
 RequestOptions options)
                             throws StripeException

Returns the shipping rate object with the given ID.

Throws:

StripeException

retrieve

public static ShippingRate retrieve(String shippingRateToken,
 ShippingRateRetrieveParams params,
 RequestOptions options)
                             throws StripeException

Returns the shipping rate object with the given ID.

Throws:

StripeException

update

public ShippingRate update(Map<String,Object> params)
                    throws StripeException

Updates an existing shipping rate object.

Specified by:

update in interface MetadataStore<ShippingRate>

Throws:

StripeException

update

public ShippingRate update(Map<String,Object> params,
 RequestOptions options)
                    throws StripeException

Updates an existing shipping rate object.

Specified by:

update in interface MetadataStore<ShippingRate>

Throws:

StripeException

update

public ShippingRate update(ShippingRateUpdateParams params)
                    throws StripeException

Updates an existing shipping rate object.

Throws:

StripeException

update

public ShippingRate update(ShippingRateUpdateParams params,
 RequestOptions options)
                    throws StripeException

Updates an existing shipping rate object.

Throws:

StripeException

getActive

public Boolean getActive()

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

getCreated

public Long getCreated()

Time at which the object was created. Measured in seconds since the Unix epoch.

getDeliveryEstimate

public ShippingRate.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()

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

getFixedAmount

public ShippingRate.FixedAmount getFixedAmount()

getLivemode

public Boolean getLivemode()

Has the value true if the object exists in live mode or the value false if the object exists in test mode.

getObject

public String getObject()

String representing the object's type. Objects of the same type share the same value.

Equal to shipping_rate.

getTaxBehavior

public String getTaxBehavior()

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

getType

public String getType()

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

Equal to fixed_amount.

setActive

public void setActive(Boolean active)

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

setCreated

public void setCreated(Long created)

Time at which the object was created. Measured in seconds since the Unix epoch.

setDeliveryEstimate

public void setDeliveryEstimate(ShippingRate.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 void setDisplayName(String displayName)

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

setFixedAmount

public void setFixedAmount(ShippingRate.FixedAmount fixedAmount)

setId

public void setId(String id)

Unique identifier for the object.

setLivemode

public void setLivemode(Boolean livemode)

Has the value true if the object exists in live mode or the value false if the object exists in test mode.

setMetadata

public void setMetadata(Map<String,String> metadata)

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.

setObject

public void setObject(String object)

String representing the object's type. Objects of the same type share the same value.

Equal to shipping_rate.

setTaxBehavior

public void setTaxBehavior(String taxBehavior)

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

setType

public void setType(String type)

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

Equal to fixed_amount.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

canEqual

protected boolean canEqual(Object other)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

getId

public String getId()

Unique identifier for the object.

Specified by:

getId in interface HasId

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.

Specified by:

getMetadata in interface MetadataStore<ShippingRate>