Package com.stripe.model

Class Order

java.lang.Object
com.stripe.model.StripeObject
com.stripe.net.ApiResource
com.stripe.model.Order
All Implemented Interfaces:
HasId, MetadataStore<Order>, StripeObjectInterface
public class Order extends ApiResource implements HasId, MetadataStore<Order>

  • Constructor Details

    • Order

      public Order()

  • Method Details

    • getCharge

      public String getCharge()
      Get ID of expandable charge object.

    • setCharge

      public void setCharge(String id)

    • getChargeObject

      public Charge getChargeObject()
      Get expanded charge.

    • setChargeObject

      public void setChargeObject(Charge expandableObject)

    • getCustomer

      public String getCustomer()
      Get ID of expandable customer object.

    • setCustomer

      public void setCustomer(String id)

    • getCustomerObject

      public Customer getCustomerObject()
      Get expanded customer.

    • setCustomerObject

      public void setCustomerObject(Customer expandableObject)

    • create

      public static Order create(Map<String,Object> params) throws StripeException
      Creates a new order object.
      Throws:
      StripeException

    • create

      public static Order create(Map<String,Object> params, RequestOptions options) throws StripeException
      Creates a new order object.
      Throws:
      StripeException

    • create

      public static Order create(OrderCreateParams params) throws StripeException
      Creates a new order object.
      Throws:
      StripeException

    • create

      public static Order create(OrderCreateParams params, RequestOptions options) throws StripeException
      Creates a new order object.
      Throws:
      StripeException

    • list

      public static OrderCollection list(Map<String,Object> params) throws StripeException
      Returns a list of your orders. The orders are returned sorted by creation date, with the most recently created orders appearing first.
      Throws:
      StripeException

    • list

      public static OrderCollection list(Map<String,Object> params, RequestOptions options) throws StripeException
      Returns a list of your orders. The orders are returned sorted by creation date, with the most recently created orders appearing first.
      Throws:
      StripeException

    • list

      public static OrderCollection list(OrderListParams params) throws StripeException
      Returns a list of your orders. The orders are returned sorted by creation date, with the most recently created orders appearing first.
      Throws:
      StripeException

    • list

      public static OrderCollection list(OrderListParams params, RequestOptions options) throws StripeException
      Returns a list of your orders. The orders are returned sorted by creation date, with the most recently created orders appearing first.
      Throws:
      StripeException

    • retrieve

      public static Order retrieve(String id) throws StripeException
      Retrieves the details of an existing order. Supply the unique order ID from either an order creation request or the order list, and Stripe will return the corresponding order information.
      Throws:
      StripeException

    • retrieve

      public static Order retrieve(String id, RequestOptions options) throws StripeException
      Retrieves the details of an existing order. Supply the unique order ID from either an order creation request or the order list, and Stripe will return the corresponding order information.
      Throws:
      StripeException

    • retrieve

      public static Order retrieve(String id, Map<String,Object> params, RequestOptions options) throws StripeException
      Retrieves the details of an existing order. Supply the unique order ID from either an order creation request or the order list, and Stripe will return the corresponding order information.
      Throws:
      StripeException

    • retrieve

      public static Order retrieve(String id, OrderRetrieveParams params, RequestOptions options) throws StripeException
      Retrieves the details of an existing order. Supply the unique order ID from either an order creation request or the order list, and Stripe will return the corresponding order information.
      Throws:
      StripeException

    • update

      public Order update(Map<String,Object> params) throws StripeException
      Updates the specific order by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
      Specified by:
      update in interface MetadataStore<Order>
      Throws:
      StripeException

    • update

      public Order update(Map<String,Object> params, RequestOptions options) throws StripeException
      Updates the specific order by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
      Specified by:
      update in interface MetadataStore<Order>
      Throws:
      StripeException

    • update

      public Order update(OrderUpdateParams params) throws StripeException
      Updates the specific order by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
      Throws:
      StripeException

    • update

      public Order update(OrderUpdateParams params, RequestOptions options) throws StripeException
      Updates the specific order by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
      Throws:
      StripeException

    • pay

      public Order pay() throws StripeException
      Pay an order by providing a source to create a payment.
      Throws:
      StripeException

    • pay

      public Order pay(RequestOptions options) throws StripeException
      Pay an order by providing a source to create a payment.
      Throws:
      StripeException

    • pay

      public Order pay(Map<String,Object> params) throws StripeException
      Pay an order by providing a source to create a payment.
      Throws:
      StripeException

    • pay

      public Order pay(Map<String,Object> params, RequestOptions options) throws StripeException
      Pay an order by providing a source to create a payment.
      Throws:
      StripeException

    • pay

      public Order pay(OrderPayParams params) throws StripeException
      Pay an order by providing a source to create a payment.
      Throws:
      StripeException

    • pay

      public Order pay(OrderPayParams params, RequestOptions options) throws StripeException
      Pay an order by providing a source to create a payment.
      Throws:
      StripeException

    • returnOrder

      public OrderReturn returnOrder() throws StripeException
      Return all or part of an order. The order must have a status of paid or fulfilled before it can be returned. Once all items have been returned, the order will become canceled or returned depending on which status the order started in.
      Throws:
      StripeException

    • returnOrder

      public OrderReturn returnOrder(RequestOptions options) throws StripeException
      Return all or part of an order. The order must have a status of paid or fulfilled before it can be returned. Once all items have been returned, the order will become canceled or returned depending on which status the order started in.
      Throws:
      StripeException

    • returnOrder

      public OrderReturn returnOrder(Map<String,Object> params) throws StripeException
      Return all or part of an order. The order must have a status of paid or fulfilled before it can be returned. Once all items have been returned, the order will become canceled or returned depending on which status the order started in.
      Throws:
      StripeException

    • returnOrder

      public OrderReturn returnOrder(Map<String,Object> params, RequestOptions options) throws StripeException
      Return all or part of an order. The order must have a status of paid or fulfilled before it can be returned. Once all items have been returned, the order will become canceled or returned depending on which status the order started in.
      Throws:
      StripeException

    • returnOrder

      public OrderReturn returnOrder(OrderReturnOrderParams params) throws StripeException
      Return all or part of an order. The order must have a status of paid or fulfilled before it can be returned. Once all items have been returned, the order will become canceled or returned depending on which status the order started in.
      Throws:
      StripeException

    • returnOrder

      public OrderReturn returnOrder(OrderReturnOrderParams params, RequestOptions options) throws StripeException
      Return all or part of an order. The order must have a status of paid or fulfilled before it can be returned. Once all items have been returned, the order will become canceled or returned depending on which status the order started in.
      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 order.

    • getAmountReturned

      public Long getAmountReturned()
      The total amount that was returned to the customer.

    • getApplication

      public String getApplication()
      ID of the Connect Application that created the order.

    • getApplicationFee

      public Long getApplicationFee()
      A fee in cents that will be applied to the order and transferred to the application owner’s Stripe account. The request must be made with an OAuth key or the Stripe-Account header in order to take an application fee. For more information, see the application fees documentation.

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

    • getEmail

      public String getEmail()
      The email address of the customer placing the order.

    • getExternalCouponCode

      public String getExternalCouponCode()
      External coupon code to load for this order.

    • getItems

      public List<OrderItem> getItems()
      List of items constituting the order. An order can have up to 25 items.

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

    • getReturns

      public OrderReturnCollection getReturns()
      A list of returns that have taken place for this order.

    • getSelectedShippingMethod

      public String getSelectedShippingMethod()
      The shipping method that is currently selected for this order, if any. If present, it is equal to one of the ids of shipping methods in the shipping_methods array. At order creation time, if there are multiple shipping methods, Stripe will automatically selected the first method.

    • getShipping

      public ShippingDetails getShipping()
      The shipping address for the order. Present if the order is for goods to be shipped.

    • getShippingMethods

      public List<Order.ShippingMethod> getShippingMethods()
      A list of supported shipping methods for this order. The desired shipping method can be specified either by updating the order, or when paying it.

    • getStatus

      public String getStatus()
      Current order status. One of created, paid, canceled, fulfilled, or returned. More details in the Orders Guide.

    • getStatusTransitions

      public Order.StatusTransitions getStatusTransitions()
      The timestamps at which the order status was updated.

    • getUpdated

      public Long getUpdated()
      Time at which the object was last updated. Measured in seconds since the Unix epoch.

    • getUpstreamId

      public String getUpstreamId()
      The user's order ID if it is different from the Stripe order ID.

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

    • setAmountReturned

      public void setAmountReturned(Long amountReturned)
      The total amount that was returned to the customer.

    • setApplication

      public void setApplication(String application)
      ID of the Connect Application that created the order.

    • setApplicationFee

      public void setApplicationFee(Long applicationFee)
      A fee in cents that will be applied to the order and transferred to the application owner’s Stripe account. The request must be made with an OAuth key or the Stripe-Account header in order to take an application fee. For more information, see the application fees documentation.

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

    • setEmail

      public void setEmail(String email)
      The email address of the customer placing the order.

    • setExternalCouponCode

      public void setExternalCouponCode(String externalCouponCode)
      External coupon code to load for this order.

    • setId

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

    • setItems

      public void setItems(List<OrderItem> items)
      List of items constituting the order. An order can have up to 25 items.

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

    • setReturns

      public void setReturns(OrderReturnCollection returns)
      A list of returns that have taken place for this order.

    • setSelectedShippingMethod

      public void setSelectedShippingMethod(String selectedShippingMethod)
      The shipping method that is currently selected for this order, if any. If present, it is equal to one of the ids of shipping methods in the shipping_methods array. At order creation time, if there are multiple shipping methods, Stripe will automatically selected the first method.

    • setShipping

      public void setShipping(ShippingDetails shipping)
      The shipping address for the order. Present if the order is for goods to be shipped.

    • setShippingMethods

      public void setShippingMethods(List<Order.ShippingMethod> shippingMethods)
      A list of supported shipping methods for this order. The desired shipping method can be specified either by updating the order, or when paying it.

    • setStatus

      public void setStatus(String status)
      Current order status. One of created, paid, canceled, fulfilled, or returned. More details in the Orders Guide.

    • setStatusTransitions

      public void setStatusTransitions(Order.StatusTransitions statusTransitions)
      The timestamps at which the order status was updated.

    • setUpdated

      public void setUpdated(Long updated)
      Time at which the object was last updated. Measured in seconds since the Unix epoch.

    • setUpstreamId

      public void setUpstreamId(String upstreamId)
      The user's order ID if it is different from the Stripe order ID.

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