com.stripe.param

Class OrderUpdateParams

java.lang.Object

com.stripe.net.ApiRequestParams

com.stripe.param.OrderUpdateParams

public class OrderUpdateParams
extends ApiRequestParams

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	OrderUpdateParams.Builder
static class	OrderUpdateParams.Shipping
static class	OrderUpdateParams.Status The tracking number provided by the carrier.

Nested classes/interfaces inherited from class com.stripe.net.ApiRequestParams

ApiRequestParams.EnumParam

Field Summary

Fields inherited from class com.stripe.net.ApiRequestParams

EXTRA_PARAMS_KEY

Method Summary

Modifier and Type	Method and Description
static OrderUpdateParams.Builder	builder()
java.lang.Object	getCoupon() A coupon code that represents a discount to be applied to this order.
java.util.List<java.lang.String>	getExpand() Specifies which fields in the response should be expanded.
java.util.Map<java.lang.String,java.lang.Object>	getExtraParams() Map of extra parameters for custom features not available in this client library.
java.util.Map<java.lang.String,java.lang.String>	getMetadata() Set of key-value pairs that you can attach to an object.
java.lang.Object	getSelectedShippingMethod() The shipping method to select for fulfilling this order.
OrderUpdateParams.Shipping	getShipping() Tracking information once the order has been fulfilled.
OrderUpdateParams.Status	getStatus() Current order status.

Methods inherited from class com.stripe.net.ApiRequestParams

toMap

Methods inherited from class java.lang.Object

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

Method Detail

builder

public static OrderUpdateParams.Builder builder()

getCoupon

public java.lang.Object getCoupon()

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.

getExpand

public java.util.List<java.lang.String> getExpand()

Specifies which fields in the response should be expanded.

getExtraParams

public java.util.Map<java.lang.String,java.lang.Object> getExtraParams()

Map of extra parameters for custom features not available in this client library. The content in this map is not serialized under this field's @SerializedName value. Instead, each key/value pair is serialized as if the key is a root-level field (serialized) name in this param object. Effectively, this map is flattened to its parent instance.

getMetadata

public java.util.Map<java.lang.String,java.lang.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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to metadata.

getSelectedShippingMethod

public java.lang.Object getSelectedShippingMethod()

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

getShipping

public OrderUpdateParams.Shipping getShipping()

Tracking information once the order has been fulfilled.

getStatus

public OrderUpdateParams.Status getStatus()

Current order status. One of created, paid, canceled, fulfilled, or returned. More detail in the Orders Guide.