com.stripe.param

Class OrderPayParams.Builder

java.lang.Object

com.stripe.param.OrderPayParams.Builder

Enclosing class:

OrderPayParams

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

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
OrderPayParams.Builder	addAllExpand(java.util.List<java.lang.String> elements) Add all elements to `expand` list.
OrderPayParams.Builder	addExpand(java.lang.String element) Add an element to `expand` list.
OrderPayParams	build() Finalize and obtain parameter instance from this builder.
OrderPayParams.Builder	putAllExtraParam(java.util.Map<java.lang.String,java.lang.Object> map) Add all map key/value pairs to `extraParams` map.
OrderPayParams.Builder	putAllMetadata(java.util.Map<java.lang.String,java.lang.String> map) Add all map key/value pairs to `metadata` map.
OrderPayParams.Builder	putExtraParam(java.lang.String key, java.lang.Object value) Add a key/value pair to `extraParams` map.
OrderPayParams.Builder	putMetadata(java.lang.String key, java.lang.String value) Add a key/value pair to `metadata` map.
OrderPayParams.Builder	setApplicationFee(java.lang.Long applicationFee) A fee in %s that will be applied to the order and transferred to the application owner's Stripe account.
OrderPayParams.Builder	setCustomer(java.lang.String customer) The ID of an existing customer that will be charged for this order.
OrderPayParams.Builder	setEmail(java.lang.String email) The email address of the customer placing the order.
OrderPayParams.Builder	setSource(java.lang.String source) A [Token](https://stripe.com/docs/api#tokens)'s or a [Source](https://stripe.com/docs/api#sources)'s ID, as returned by [Elements](https://stripe.com/docs/elements).

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

Finalize and obtain parameter instance from this builder.

setApplicationFee

public OrderPayParams.Builder setApplicationFee(java.lang.Long applicationFee)

A fee in %s that will be applied to the order and transferred to the application owner's Stripe account. The request must be made with an OAuth key or the `Stripe-Account` header in order to take an application fee. For more information, see the application fees [documentation](https://stripe.com/docs/connect/direct-charges#collecting-fees).

setCustomer

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

The ID of an existing customer that will be charged for this order. If no customer was attached to the order at creation, either `source` or `customer` is required. Otherwise, the specified customer will be charged instead of the one attached to the order.

setEmail

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

The email address of the customer placing the order. Required if not previously specified for the order.

addExpand

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

addAllExpand

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

putExtraParam

public OrderPayParams.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 OrderPayParams.extraParams for the field documentation.

putAllExtraParam

public OrderPayParams.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 OrderPayParams.extraParams for the field documentation.

putMetadata

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

putAllMetadata

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

setSource

public OrderPayParams.Builder setSource(java.lang.String source)

A [Token](https://stripe.com/docs/api#tokens)'s or a [Source](https://stripe.com/docs/api#sources)'s ID, as returned by [Elements](https://stripe.com/docs/elements). If no customer was attached to the order at creation, either `source` or `customer` is required. Otherwise, the specified source will be charged intead of the customer attached to the order.