Package com.stripe.param

Class InvoiceCreatePreviewParams.SubscriptionDetails.Item.Builder

java.lang.Object

com.stripe.param.InvoiceCreatePreviewParams.SubscriptionDetails.Item.Builder

Enclosing class:

InvoiceCreatePreviewParams.SubscriptionDetails.Item

public static class InvoiceCreatePreviewParams.SubscriptionDetails.Item.Builder
extends Object

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
InvoiceCreatePreviewParams.SubscriptionDetails.Item.Builder	addAllDiscount(List<InvoiceCreatePreviewParams.SubscriptionDetails.Item.Discount> elements)	Add all elements to `discounts` list.
InvoiceCreatePreviewParams.SubscriptionDetails.Item.Builder	addAllTaxRate(List<String> elements)	Add all elements to `taxRates` list.
InvoiceCreatePreviewParams.SubscriptionDetails.Item.Builder	addDiscount(InvoiceCreatePreviewParams.SubscriptionDetails.Item.Discount element)	Add an element to `discounts` list.
InvoiceCreatePreviewParams.SubscriptionDetails.Item.Builder	addTaxRate(String element)	Add an element to `taxRates` list.
InvoiceCreatePreviewParams.SubscriptionDetails.Item	build()	Finalize and obtain parameter instance from this builder.
InvoiceCreatePreviewParams.SubscriptionDetails.Item.Builder	putAllExtraParam(Map<String,Object> map)	Add all map key/value pairs to `extraParams` map.
InvoiceCreatePreviewParams.SubscriptionDetails.Item.Builder	putAllMetadata(Map<String,String> map)	Add all map key/value pairs to `metadata` map.
InvoiceCreatePreviewParams.SubscriptionDetails.Item.Builder	putExtraParam(String key, Object value)	Add a key/value pair to `extraParams` map.
InvoiceCreatePreviewParams.SubscriptionDetails.Item.Builder	putMetadata(String key, String value)	Add a key/value pair to `metadata` map.
InvoiceCreatePreviewParams.SubscriptionDetails.Item.Builder	setBillingThresholds(EmptyParam billingThresholds)	Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period.
InvoiceCreatePreviewParams.SubscriptionDetails.Item.Builder	setBillingThresholds(InvoiceCreatePreviewParams.SubscriptionDetails.Item.BillingThresholds billingThresholds)	Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period.
InvoiceCreatePreviewParams.SubscriptionDetails.Item.Builder	setClearUsage(Boolean clearUsage)	Delete all usage for a given subscription item.
InvoiceCreatePreviewParams.SubscriptionDetails.Item.Builder	setDeleted(Boolean deleted)	A flag that, if set to true, will delete the specified item.
InvoiceCreatePreviewParams.SubscriptionDetails.Item.Builder	setDiscounts(EmptyParam discounts)	The coupons to redeem into discounts for the subscription item.
InvoiceCreatePreviewParams.SubscriptionDetails.Item.Builder	setDiscounts(List<InvoiceCreatePreviewParams.SubscriptionDetails.Item.Discount> discounts)	The coupons to redeem into discounts for the subscription item.
InvoiceCreatePreviewParams.SubscriptionDetails.Item.Builder	setId(String id)	Subscription item to update.
InvoiceCreatePreviewParams.SubscriptionDetails.Item.Builder	setMetadata(EmptyParam metadata)	Set of key-value pairs that you can attach to an object.
InvoiceCreatePreviewParams.SubscriptionDetails.Item.Builder	setMetadata(Map<String,String> metadata)	Set of key-value pairs that you can attach to an object.
InvoiceCreatePreviewParams.SubscriptionDetails.Item.Builder	setPlan(String plan)	Plan ID for this item, as a string.
InvoiceCreatePreviewParams.SubscriptionDetails.Item.Builder	setPrice(String price)	The ID of the price object.
InvoiceCreatePreviewParams.SubscriptionDetails.Item.Builder	setPriceData(InvoiceCreatePreviewParams.SubscriptionDetails.Item.PriceData priceData)	Data used to generate a new Price object inline.
InvoiceCreatePreviewParams.SubscriptionDetails.Item.Builder	setQuantity(Long quantity)	Quantity for this item.
InvoiceCreatePreviewParams.SubscriptionDetails.Item.Builder	setTaxRates(EmptyParam taxRates)	A list of Tax Rate ids.
InvoiceCreatePreviewParams.SubscriptionDetails.Item.Builder	setTaxRates(List<String> taxRates)	A list of Tax Rate ids.

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 InvoiceCreatePreviewParams.SubscriptionDetails.Item build()

Finalize and obtain parameter instance from this builder.

setBillingThresholds

public InvoiceCreatePreviewParams.SubscriptionDetails.Item.Builder setBillingThresholds(InvoiceCreatePreviewParams.SubscriptionDetails.Item.BillingThresholds billingThresholds)

Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. When updating, pass an empty string to remove previously-defined thresholds.

setBillingThresholds

public InvoiceCreatePreviewParams.SubscriptionDetails.Item.Builder setBillingThresholds(EmptyParam billingThresholds)

Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. When updating, pass an empty string to remove previously-defined thresholds.

setClearUsage

public InvoiceCreatePreviewParams.SubscriptionDetails.Item.Builder setClearUsage(Boolean clearUsage)

Delete all usage for a given subscription item. Allowed only when deleted is set to true and the current plan's usage_type is metered.

setDeleted

public InvoiceCreatePreviewParams.SubscriptionDetails.Item.Builder setDeleted(Boolean deleted)

A flag that, if set to true, will delete the specified item.

addDiscount

public InvoiceCreatePreviewParams.SubscriptionDetails.Item.Builder addDiscount(InvoiceCreatePreviewParams.SubscriptionDetails.Item.Discount element)

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

addAllDiscount

public InvoiceCreatePreviewParams.SubscriptionDetails.Item.Builder addAllDiscount(List<InvoiceCreatePreviewParams.SubscriptionDetails.Item.Discount> elements)

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

setDiscounts

public InvoiceCreatePreviewParams.SubscriptionDetails.Item.Builder setDiscounts(EmptyParam discounts)

The coupons to redeem into discounts for the subscription item.

setDiscounts

public InvoiceCreatePreviewParams.SubscriptionDetails.Item.Builder setDiscounts(List<InvoiceCreatePreviewParams.SubscriptionDetails.Item.Discount> discounts)

The coupons to redeem into discounts for the subscription item.

putExtraParam

public InvoiceCreatePreviewParams.SubscriptionDetails.Item.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 InvoiceCreatePreviewParams.SubscriptionDetails.Item.extraParams for the field documentation.

putAllExtraParam

public InvoiceCreatePreviewParams.SubscriptionDetails.Item.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 InvoiceCreatePreviewParams.SubscriptionDetails.Item.extraParams for the field documentation.

setId

public InvoiceCreatePreviewParams.SubscriptionDetails.Item.Builder setId(String id)

Subscription item to update.

putMetadata

public InvoiceCreatePreviewParams.SubscriptionDetails.Item.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 InvoiceCreatePreviewParams.SubscriptionDetails.Item.metadata for the field documentation.

putAllMetadata

public InvoiceCreatePreviewParams.SubscriptionDetails.Item.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 InvoiceCreatePreviewParams.SubscriptionDetails.Item.metadata for the field documentation.

setMetadata

public InvoiceCreatePreviewParams.SubscriptionDetails.Item.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 InvoiceCreatePreviewParams.SubscriptionDetails.Item.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.

setPlan

public InvoiceCreatePreviewParams.SubscriptionDetails.Item.Builder setPlan(String plan)

Plan ID for this item, as a string.

setPrice

public InvoiceCreatePreviewParams.SubscriptionDetails.Item.Builder setPrice(String price)

The ID of the price object. One of price or price_data is required. When changing a subscription item's price, quantity is set to 1 unless a quantity parameter is provided.

setPriceData

public InvoiceCreatePreviewParams.SubscriptionDetails.Item.Builder setPriceData(InvoiceCreatePreviewParams.SubscriptionDetails.Item.PriceData priceData)

Data used to generate a new Price object inline. One of price or price_data is required.

setQuantity

public InvoiceCreatePreviewParams.SubscriptionDetails.Item.Builder setQuantity(Long quantity)

Quantity for this item.

addTaxRate

public InvoiceCreatePreviewParams.SubscriptionDetails.Item.Builder addTaxRate(String element)

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

addAllTaxRate

public InvoiceCreatePreviewParams.SubscriptionDetails.Item.Builder addAllTaxRate(List<String> elements)

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

setTaxRates

public InvoiceCreatePreviewParams.SubscriptionDetails.Item.Builder setTaxRates(EmptyParam taxRates)

A list of Tax Rate ids. These Tax Rates will override the default_tax_rates on the Subscription. When updating, pass an empty string to remove previously-defined tax rates.

setTaxRates

public InvoiceCreatePreviewParams.SubscriptionDetails.Item.Builder setTaxRates(List<String> taxRates)

A list of Tax Rate ids. These Tax Rates will override the default_tax_rates on the Subscription. When updating, pass an empty string to remove previously-defined tax rates.