com.stripe.param

Class OrderCreateParams.Builder

java.lang.Object

com.stripe.param.OrderCreateParams.Builder

Enclosing class:

OrderCreateParams

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

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
OrderCreateParams.Builder	addAllExpand(java.util.List<java.lang.String> elements) Add all elements to `expand` list.
OrderCreateParams.Builder	addAllItem(java.util.List<OrderCreateParams.Item> elements) Add all elements to `items` list.
OrderCreateParams.Builder	addExpand(java.lang.String element) Add an element to `expand` list.
OrderCreateParams.Builder	addItem(OrderCreateParams.Item element) Add an element to `items` list.
OrderCreateParams	build() Finalize and obtain parameter instance from this builder.
OrderCreateParams.Builder	putAllMetadata(java.util.Map<java.lang.String,java.lang.String> map) Add all map key/value pairs to `metadata` map.
OrderCreateParams.Builder	putMetadata(java.lang.String key, java.lang.String value) Add a key/value pair to `metadata` map.
OrderCreateParams.Builder	setCoupon(java.lang.String coupon) A coupon code that represents a discount to be applied to this order.
OrderCreateParams.Builder	setCurrency(java.lang.String currency) Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase.
OrderCreateParams.Builder	setCustomer(java.lang.String customer) The ID of an existing customer to use for this order.
OrderCreateParams.Builder	setEmail(java.lang.String email) The email address of the customer placing the order.
OrderCreateParams.Builder	setShipping(OrderCreateParams.Shipping shipping) Shipping address for the order.

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 OrderCreateParams build()

Finalize and obtain parameter instance from this builder.

setCoupon

public OrderCreateParams.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.

setCurrency

public OrderCreateParams.Builder setCurrency(java.lang.String currency)

Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).

setCustomer

public OrderCreateParams.Builder setCustomer(java.lang.String customer)

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. If `email` or `shipping` are also provided, they will override the values retrieved from the customer object.

setEmail

public OrderCreateParams.Builder setEmail(java.lang.String email)

The email address of the customer placing the order.

addExpand

public OrderCreateParams.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 OrderCreateParams.expand for the field documentation.

addAllExpand

public OrderCreateParams.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 OrderCreateParams.expand for the field documentation.

addItem

public OrderCreateParams.Builder addItem(OrderCreateParams.Item element)

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

addAllItem

public OrderCreateParams.Builder addAllItem(java.util.List<OrderCreateParams.Item> elements)

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

putMetadata

public OrderCreateParams.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 OrderCreateParams.metadata for the field documentation.

putAllMetadata

public OrderCreateParams.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 OrderCreateParams.metadata for the field documentation.

setShipping

public OrderCreateParams.Builder setShipping(OrderCreateParams.Shipping shipping)

Shipping address for the order. Required if any of the SKUs are for products that have `shippable` set to true.