Package com.stripe.model

Class OrderReturn

java.lang.Object

com.stripe.model.StripeObject

com.stripe.net.ApiResource

com.stripe.model.OrderReturn

All Implemented Interfaces:

HasId, StripeObjectInterface

public class OrderReturn
extends ApiResource
implements HasId

Nested Class Summary

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
OrderReturn()

Method Summary

Modifier and Type	Method	Description
protected boolean	canEqual(java.lang.Object other)
boolean	equals(java.lang.Object o)
java.lang.Long	getAmount()	A positive integer in the smallest currency unit (that is, 100 cents for $1.00, or 1 for ¥1, Japanese Yen being a zero-decimal currency) representing the total amount for the returned line item.
java.lang.Long	getCreated()	Time at which the object was created.
java.lang.String	getCurrency()	Three-letter ISO currency code, in lowercase.
java.lang.String	getId()	Unique identifier for the object.
java.util.List<OrderItem>	getItems()	The items included in this order return.
java.lang.Boolean	getLivemode()	Has the value true if the object exists in live mode or the value false if the object exists in test mode.
java.lang.String	getObject()	String representing the object's type.
java.lang.String	getOrder()	Get ID of expandable order object.
Order	getOrderObject()	Get expanded order.
java.lang.String	getRefund()	Get ID of expandable refund object.
Refund	getRefundObject()	Get expanded refund.
int	hashCode()
static OrderReturnCollection	list(OrderReturnListParams params)	Returns a list of your order returns.
static OrderReturnCollection	list(OrderReturnListParams params, RequestOptions options)	Returns a list of your order returns.
static OrderReturnCollection	list(java.util.Map<java.lang.String,java.lang.Object> params)	Returns a list of your order returns.
static OrderReturnCollection	list(java.util.Map<java.lang.String,java.lang.Object> params, RequestOptions options)	Returns a list of your order returns.
static OrderReturn	retrieve(java.lang.String id)	Retrieves the details of an existing order return.
static OrderReturn	retrieve(java.lang.String id, RequestOptions options)	Retrieves the details of an existing order return.
static OrderReturn	retrieve(java.lang.String id, OrderReturnRetrieveParams params, RequestOptions options)	Retrieves the details of an existing order return.
static OrderReturn	retrieve(java.lang.String id, java.util.Map<java.lang.String,java.lang.Object> params, RequestOptions options)	Retrieves the details of an existing order return.
void	setAmount(java.lang.Long amount)	A positive integer in the smallest currency unit (that is, 100 cents for $1.00, or 1 for ¥1, Japanese Yen being a zero-decimal currency) representing the total amount for the returned line item.
void	setCreated(java.lang.Long created)	Time at which the object was created.
void	setCurrency(java.lang.String currency)	Three-letter ISO currency code, in lowercase.
void	setId(java.lang.String id)	Unique identifier for the object.
void	setItems(java.util.List<OrderItem> items)	The items included in this order return.
void	setLivemode(java.lang.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	setObject(java.lang.String object)	String representing the object's type.
void	setOrder(java.lang.String id)
void	setOrderObject(Order expandableObject)
void	setRefund(java.lang.String id)
void	setRefundObject(Refund expandableObject)

Methods inherited from class com.stripe.net.ApiResource

checkNullTypedParams, classUrl, classUrl, instanceUrl, instanceUrl, request, request, requestCollection, requestCollection, 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 Detail

OrderReturn

public OrderReturn()

Method Detail

getOrder

public java.lang.String getOrder()

Get ID of expandable order object.

setOrder

public void setOrder(java.lang.String id)

getOrderObject

public Order getOrderObject()

Get expanded order.

setOrderObject

public void setOrderObject(Order expandableObject)

getRefund

public java.lang.String getRefund()

Get ID of expandable refund object.

setRefund

public void setRefund(java.lang.String id)

getRefundObject

public Refund getRefundObject()

Get expanded refund.

setRefundObject

public void setRefundObject(Refund expandableObject)

list

public static OrderReturnCollection list(java.util.Map<java.lang.String,java.lang.Object> params)
                                  throws StripeException

Returns a list of your order returns. The returns are returned sorted by creation date, with the most recently created return appearing first.

Throws:

StripeException

list

public static OrderReturnCollection list(java.util.Map<java.lang.String,java.lang.Object> params,
                                         RequestOptions options)
                                  throws StripeException

Returns a list of your order returns. The returns are returned sorted by creation date, with the most recently created return appearing first.

Throws:

StripeException

list

public static OrderReturnCollection list(OrderReturnListParams params)
                                  throws StripeException

Returns a list of your order returns. The returns are returned sorted by creation date, with the most recently created return appearing first.

Throws:

StripeException

list

public static OrderReturnCollection list(OrderReturnListParams params,
                                         RequestOptions options)
                                  throws StripeException

Returns a list of your order returns. The returns are returned sorted by creation date, with the most recently created return appearing first.

Throws:

StripeException

retrieve

public static OrderReturn retrieve(java.lang.String id)
                            throws StripeException

Retrieves the details of an existing order return. Supply the unique order ID from either an order return creation request or the order return list, and Stripe will return the corresponding order information.

Throws:

StripeException

retrieve

public static OrderReturn retrieve(java.lang.String id,
                                   RequestOptions options)
                            throws StripeException

Retrieves the details of an existing order return. Supply the unique order ID from either an order return creation request or the order return list, and Stripe will return the corresponding order information.

Throws:

StripeException

retrieve

public static OrderReturn retrieve(java.lang.String id,
                                   java.util.Map<java.lang.String,java.lang.Object> params,
                                   RequestOptions options)
                            throws StripeException

Retrieves the details of an existing order return. Supply the unique order ID from either an order return creation request or the order return list, and Stripe will return the corresponding order information.

Throws:

StripeException

retrieve

public static OrderReturn retrieve(java.lang.String id,
                                   OrderReturnRetrieveParams params,
                                   RequestOptions options)
                            throws StripeException

Retrieves the details of an existing order return. Supply the unique order ID from either an order return creation request or the order return list, and Stripe will return the corresponding order information.

Throws:

StripeException

getAmount

public java.lang.Long getAmount()

A positive integer in the smallest currency unit (that is, 100 cents for $1.00, or 1 for ¥1, Japanese Yen being a zero-decimal currency) representing the total amount for the returned line item.

getCreated

public java.lang.Long getCreated()

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

getCurrency

public java.lang.String getCurrency()

Three-letter ISO currency code, in lowercase. Must be a supported currency.

getItems

public java.util.List<OrderItem> getItems()

The items included in this order return.

getLivemode

public java.lang.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 java.lang.String getObject()

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

Equal to order_return.

setAmount

public void setAmount(java.lang.Long amount)

A positive integer in the smallest currency unit (that is, 100 cents for $1.00, or 1 for ¥1, Japanese Yen being a zero-decimal currency) representing the total amount for the returned line item.

setCreated

public void setCreated(java.lang.Long created)

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

setCurrency

public void setCurrency(java.lang.String currency)

Three-letter ISO currency code, in lowercase. Must be a supported currency.

setId

public void setId(java.lang.String id)

Unique identifier for the object.

setItems

public void setItems(java.util.List<OrderItem> items)

The items included in this order return.

setLivemode

public void setLivemode(java.lang.Boolean livemode)

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

setObject

public void setObject(java.lang.String object)

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

Equal to order_return.

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

canEqual

protected boolean canEqual(java.lang.Object other)

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

getId

public java.lang.String getId()

Unique identifier for the object.

Specified by:

getId in interface HasId