Package com.stripe.param.checkout

Class SessionCreateParams.Discount.CouponData.Builder

java.lang.Object

com.stripe.param.checkout.SessionCreateParams.Discount.CouponData.Builder

Enclosing class:

SessionCreateParams.Discount.CouponData

public static class SessionCreateParams.Discount.CouponData.Builder
extends Object

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
SessionCreateParams.Discount.CouponData	build()	Finalize and obtain parameter instance from this builder.
SessionCreateParams.Discount.CouponData.Builder	putAllExtraParam(Map<String,Object> map)	Add all map key/value pairs to `extraParams` map.
SessionCreateParams.Discount.CouponData.Builder	putAllMetadata(Map<String,String> map)	Add all map key/value pairs to `metadata` map.
SessionCreateParams.Discount.CouponData.Builder	putExtraParam(String key, Object value)	Add a key/value pair to `extraParams` map.
SessionCreateParams.Discount.CouponData.Builder	putMetadata(String key, String value)	Add a key/value pair to `metadata` map.
SessionCreateParams.Discount.CouponData.Builder	setAmountOff(Long amountOff)	A positive integer representing the amount to subtract from an invoice total (required if percent_off is not passed).
SessionCreateParams.Discount.CouponData.Builder	setCurrency(String currency)	Three-letter ISO code for the currency of the amount_off parameter (required if amount_off is passed).
SessionCreateParams.Discount.CouponData.Builder	setDuration(SessionCreateParams.Discount.CouponData.Duration duration)	Specifies how long the discount will be in effect if used on a subscription.
SessionCreateParams.Discount.CouponData.Builder	setMetadata(EmptyParam metadata)	Set of key-value pairs that you can attach to an object.
SessionCreateParams.Discount.CouponData.Builder	setMetadata(Map<String,String> metadata)	Set of key-value pairs that you can attach to an object.
SessionCreateParams.Discount.CouponData.Builder	setName(String name)	Name of the coupon displayed to customers on, for instance invoices, or receipts.
SessionCreateParams.Discount.CouponData.Builder	setPercentOff(BigDecimal percentOff)

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder()

Method Details

build

public SessionCreateParams.Discount.CouponData build()

Finalize and obtain parameter instance from this builder.

setAmountOff

public SessionCreateParams.Discount.CouponData.Builder setAmountOff(Long amountOff)

A positive integer representing the amount to subtract from an invoice total (required if percent_off is not passed).

setCurrency

public SessionCreateParams.Discount.CouponData.Builder setCurrency(String currency)

Three-letter ISO code for the currency of the amount_off parameter (required if amount_off is passed).

setDuration

public SessionCreateParams.Discount.CouponData.Builder setDuration(SessionCreateParams.Discount.CouponData.Duration duration)

Specifies how long the discount will be in effect if used on a subscription. Defaults to once.

putExtraParam

public SessionCreateParams.Discount.CouponData.Builder putExtraParam(String key,
 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 SessionCreateParams.Discount.CouponData.extraParams for the field documentation.

putAllExtraParam

public SessionCreateParams.Discount.CouponData.Builder putAllExtraParam(Map<String,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 SessionCreateParams.Discount.CouponData.extraParams for the field documentation.

putMetadata

public SessionCreateParams.Discount.CouponData.Builder putMetadata(String key,
 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 SessionCreateParams.Discount.CouponData.metadata for the field documentation.

putAllMetadata

public SessionCreateParams.Discount.CouponData.Builder putAllMetadata(Map<String,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 SessionCreateParams.Discount.CouponData.metadata for the field documentation.

setMetadata

public SessionCreateParams.Discount.CouponData.Builder setMetadata(EmptyParam metadata)

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.

setMetadata

public SessionCreateParams.Discount.CouponData.Builder setMetadata(Map<String,String> metadata)

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.

setName

public SessionCreateParams.Discount.CouponData.Builder setName(String name)

Name of the coupon displayed to customers on, for instance invoices, or receipts. By default the id is shown if name is not set.

setPercentOff

public SessionCreateParams.Discount.CouponData.Builder setPercentOff(BigDecimal percentOff)