Package com.stripe.service

Class OrderService

java.lang.Object

com.stripe.net.ApiService

com.stripe.service.OrderService

public final class OrderService
extends ApiService

Constructor Summary

Constructors

Constructor	Description
OrderService(StripeResponseGetter responseGetter)

Method Summary

Modifier and Type	Method	Description
Order	cancel(String id)	Cancels the order as well as the payment intent if one is attached.
Order	cancel(String id, RequestOptions options)	Cancels the order as well as the payment intent if one is attached.
Order	cancel(String id, OrderCancelParams params)	Cancels the order as well as the payment intent if one is attached.
Order	cancel(String id, OrderCancelParams params, RequestOptions options)	Cancels the order as well as the payment intent if one is attached.
Order	create(OrderCreateParams params)	Creates a new open order object.
Order	create(OrderCreateParams params, RequestOptions options)	Creates a new open order object.
OrderLineItemService	lineItems()
StripeCollection<Order>	list()	Returns a list of your orders.
StripeCollection<Order>	list(RequestOptions options)	Returns a list of your orders.
StripeCollection<Order>	list(OrderListParams params)	Returns a list of your orders.
StripeCollection<Order>	list(OrderListParams params, RequestOptions options)	Returns a list of your orders.
Order	reopen(String id)	Reopens a submitted order.
Order	reopen(String id, RequestOptions options)	Reopens a submitted order.
Order	reopen(String id, OrderReopenParams params)	Reopens a submitted order.
Order	reopen(String id, OrderReopenParams params, RequestOptions options)	Reopens a submitted order.
Order	retrieve(String id)	Retrieves the details of an existing order.
Order	retrieve(String id, RequestOptions options)	Retrieves the details of an existing order.
Order	retrieve(String id, OrderRetrieveParams params)	Retrieves the details of an existing order.
Order	retrieve(String id, OrderRetrieveParams params, RequestOptions options)	Retrieves the details of an existing order.
Order	submit(String id, OrderSubmitParams params)	Submitting an Order transitions the status to processing and creates a PaymentIntent object so the order can be paid.
Order	submit(String id, OrderSubmitParams params, RequestOptions options)	Submitting an Order transitions the status to processing and creates a PaymentIntent object so the order can be paid.
Order	update(String id)	Updates the specific order by setting the values of the parameters passed.
Order	update(String id, RequestOptions options)	Updates the specific order by setting the values of the parameters passed.
Order	update(String id, OrderUpdateParams params)	Updates the specific order by setting the values of the parameters passed.
Order	update(String id, OrderUpdateParams params, RequestOptions options)	Updates the specific order by setting the values of the parameters passed.

Methods inherited from class com.stripe.net.ApiService

getResponseGetter, request, requestStream

Methods inherited from class java.lang.Object

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

Constructor Details

OrderService

public OrderService(StripeResponseGetter responseGetter)

Method Details

list

public StripeCollection<Order> 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 StripeCollection<Order> list(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 StripeCollection<Order> list()
                             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 StripeCollection<Order> 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

create

public Order create(OrderCreateParams params)
             throws StripeException

Creates a new open order object.

Throws:

StripeException

create

public Order create(OrderCreateParams params,
 RequestOptions options)
             throws StripeException

Creates a new open order object.

Throws:

StripeException

retrieve

public Order retrieve(String id,
 OrderRetrieveParams params)
               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 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 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 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(String id,
 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(String id,
 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

update

public Order update(String id)
             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(String id,
 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

cancel

public Order cancel(String id,
 OrderCancelParams params)
             throws StripeException

Cancels the order as well as the payment intent if one is attached.

Throws:

StripeException

cancel

public Order cancel(String id,
 RequestOptions options)
             throws StripeException

Cancels the order as well as the payment intent if one is attached.

Throws:

StripeException

cancel

public Order cancel(String id)
             throws StripeException

Cancels the order as well as the payment intent if one is attached.

Throws:

StripeException

cancel

public Order cancel(String id,
 OrderCancelParams params,
 RequestOptions options)
             throws StripeException

Cancels the order as well as the payment intent if one is attached.

Throws:

StripeException

reopen

public Order reopen(String id,
 OrderReopenParams params)
             throws StripeException

Reopens a submitted order.

Throws:

StripeException

reopen

public Order reopen(String id,
 RequestOptions options)
             throws StripeException

Reopens a submitted order.

Throws:

StripeException

reopen

public Order reopen(String id)
             throws StripeException

Reopens a submitted order.

Throws:

StripeException

reopen

public Order reopen(String id,
 OrderReopenParams params,
 RequestOptions options)
             throws StripeException

Reopens a submitted order.

Throws:

StripeException

submit

public Order submit(String id,
 OrderSubmitParams params)
             throws StripeException

Submitting an Order transitions the status to processing and creates a PaymentIntent object so the order can be paid. If the Order has an amount_total of 0, no PaymentIntent object will be created. Once the order is submitted, its contents cannot be changed, unless the reopen method is called.

Throws:

StripeException

submit

public Order submit(String id,
 OrderSubmitParams params,
 RequestOptions options)
             throws StripeException

Submitting an Order transitions the status to processing and creates a PaymentIntent object so the order can be paid. If the Order has an amount_total of 0, no PaymentIntent object will be created. Once the order is submitted, its contents cannot be changed, unless the reopen method is called.

Throws:

StripeException

lineItems

public OrderLineItemService lineItems()