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

  • Constructor Details

    • OrderReturn

      public OrderReturn()

  • Method Details

    • getOrder

      public String getOrder()
      Get ID of expandable order object.

    • setOrder

      public void setOrder(String id)

    • getOrderObject

      public Order getOrderObject()
      Get expanded order.

    • setOrderObject

      public void setOrderObject(Order expandableObject)

    • getRefund

      public String getRefund()
      Get ID of expandable refund object.

    • setRefund

      public void setRefund(String id)

    • getRefundObject

      public Refund getRefundObject()
      Get expanded refund.

    • setRefundObject

      public void setRefundObject(Refund expandableObject)

    • list

      public static OrderReturnCollection list(Map<String,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(Map<String,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(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(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(String id, Map<String,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(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 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 Long getCreated()
      Time at which the object was created. Measured in seconds since the Unix epoch.

    • getCurrency

      public String getCurrency()
      Three-letter ISO currency code, in lowercase. Must be a supported currency.

    • getItems

      public List<OrderItem> getItems()
      The items included in this order return.

    • 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 order_return.

    • setAmount

      public void setAmount(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(Long created)
      Time at which the object was created. Measured in seconds since the Unix epoch.

    • setCurrency

      public void setCurrency(String currency)
      Three-letter ISO currency code, in lowercase. Must be a supported currency.

    • setId

      public void setId(String id)
      Unique identifier for the object.

    • setItems

      public void setItems(List<OrderItem> items)
      The items included in this order return.

    • 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.

    • setObject

      public void setObject(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(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