Package com.stripe.param
Class OrderCreateParams
- java.lang.Object
-
- com.stripe.net.ApiRequestParams
-
- com.stripe.param.OrderCreateParams
-
public class OrderCreateParams extends ApiRequestParams
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
OrderCreateParams.Builder
static class
OrderCreateParams.Item
static class
OrderCreateParams.Shipping
-
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
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static OrderCreateParams.Builder
builder()
java.lang.String
getCoupon()
A coupon code that represents a discount to be applied to this order.java.lang.String
getCurrency()
Three-letter ISO currency code, in lowercase.java.lang.String
getCustomer()
The ID of an existing customer to use for this order.java.lang.String
getEmail()
The email address of the customer placing the 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.List<OrderCreateParams.Item>
getItems()
List of items constituting the order.java.util.Map<java.lang.String,java.lang.String>
getMetadata()
Set of key-value pairs that you can attach to an object.OrderCreateParams.Shipping
getShipping()
Shipping address for the order.-
Methods inherited from class com.stripe.net.ApiRequestParams
toMap
-
-
-
-
Method Detail
-
builder
public static OrderCreateParams.Builder builder()
-
getCoupon
public java.lang.String 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.
-
getCurrency
public java.lang.String getCurrency()
Three-letter ISO currency code, in lowercase. Must be a supported currency.
-
getCustomer
public java.lang.String getCustomer()
The ID of an existing customer to use for this order. If provided, the customer email and shipping address will be used to create the order. Subsequently, the customer will also be charged to pay the order. Ifemail
orshipping
are also provided, they will override the values retrieved from the customer object.
-
getEmail
public java.lang.String getEmail()
The email address of the customer placing the order.
-
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.
-
getItems
public java.util.List<OrderCreateParams.Item> getItems()
List of items constituting the order. An order can have up to 25 items.
-
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 tometadata
.
-
getShipping
public OrderCreateParams.Shipping getShipping()
Shipping address for the order. Required if any of the SKUs are for products that haveshippable
set to true.
-
-