com.stripe.param

Class OrderUpdateParams.Builder

java.lang.Object

com.stripe.param.OrderUpdateParams.Builder

Enclosing class:

OrderUpdateParams

public static class OrderUpdateParams.Builder
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
OrderUpdateParams.Builder	addAllExpand(java.util.List<java.lang.String> elements) Add all elements to `expand` list.
OrderUpdateParams.Builder	addExpand(java.lang.String element) Add an element to `expand` list.
OrderUpdateParams	build() Finalize and obtain parameter instance from this builder.
OrderUpdateParams.Builder	putAllExtraParam(java.util.Map<java.lang.String,java.lang.Object> map) Add all map key/value pairs to `extraParams` map.
OrderUpdateParams.Builder	putAllMetadata(java.util.Map<java.lang.String,java.lang.String> map) Add all map key/value pairs to `metadata` map.
OrderUpdateParams.Builder	putExtraParam(java.lang.String key, java.lang.Object value) Add a key/value pair to `extraParams` map.
OrderUpdateParams.Builder	putMetadata(java.lang.String key, java.lang.String value) Add a key/value pair to `metadata` map.
OrderUpdateParams.Builder	setCoupon(java.lang.String coupon) A coupon code that represents a discount to be applied to this order.
OrderUpdateParams.Builder	setSelectedShippingMethod(java.lang.String selectedShippingMethod) The shipping method to select for fulfilling this order.
OrderUpdateParams.Builder	setShipping(OrderUpdateParams.Shipping shipping) Tracking information once the order has been fulfilled.
OrderUpdateParams.Builder	setStatus(OrderUpdateParams.Status status) Current order status.

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

build

public OrderUpdateParams build()

Finalize and obtain parameter instance from this builder.

setCoupon

public OrderUpdateParams.Builder setCoupon(java.lang.String coupon)

A coupon code that represents a discount to be applied to this order. Must be one-time duration and in same currency as the order. An order can have multiple coupons.

addExpand

public OrderUpdateParams.Builder addExpand(java.lang.String element)

Add an element to `expand` list. A list is initialized for the first `add/addAll` call, and subsequent calls adds additional elements to the original list. See OrderUpdateParams.expand for the field documentation.

addAllExpand

public OrderUpdateParams.Builder addAllExpand(java.util.List<java.lang.String> elements)

Add all elements to `expand` list. A list is initialized for the first `add/addAll` call, and subsequent calls adds additional elements to the original list. See OrderUpdateParams.expand for the field documentation.

putExtraParam

public OrderUpdateParams.Builder putExtraParam(java.lang.String key,
                                               java.lang.Object value)

Add a key/value pair to `extraParams` map. A map is initialized for the first `put/putAll` call, and subsequent calls add additional key/value pairs to the original map. See OrderUpdateParams.extraParams for the field documentation.

putAllExtraParam

public OrderUpdateParams.Builder putAllExtraParam(java.util.Map<java.lang.String,java.lang.Object> map)

Add all map key/value pairs to `extraParams` map. A map is initialized for the first `put/putAll` call, and subsequent calls add additional key/value pairs to the original map. See OrderUpdateParams.extraParams for the field documentation.

putMetadata

public OrderUpdateParams.Builder putMetadata(java.lang.String key,
                                             java.lang.String value)

Add a key/value pair to `metadata` map. A map is initialized for the first `put/putAll` call, and subsequent calls add additional key/value pairs to the original map. See OrderUpdateParams.metadata for the field documentation.

putAllMetadata

public OrderUpdateParams.Builder putAllMetadata(java.util.Map<java.lang.String,java.lang.String> map)

Add all map key/value pairs to `metadata` map. A map is initialized for the first `put/putAll` call, and subsequent calls add additional key/value pairs to the original map. See OrderUpdateParams.metadata for the field documentation.

setSelectedShippingMethod

public OrderUpdateParams.Builder setSelectedShippingMethod(java.lang.String selectedShippingMethod)

The shipping method to select for fulfilling this order. If specified, must be one of the `id`s of a shipping method in the `shipping_methods` array. If specified, will overwrite the existing selected shipping method, updating `items` as necessary.

setShipping

public OrderUpdateParams.Builder setShipping(OrderUpdateParams.Shipping shipping)

Tracking information once the order has been fulfilled.

setStatus

public OrderUpdateParams.Builder setStatus(OrderUpdateParams.Status status)

Current order status. One of `created`, `paid`, `canceled`, `fulfilled`, or `returned`. More detail in the [Orders Guide](https://stripe.com/docs/orders/guide#understanding-order-statuses).