Package com.stripe.param

Class SubscriptionScheduleCreateParams.Phase.Item

java.lang.Object

com.stripe.param.SubscriptionScheduleCreateParams.Phase.Item

Enclosing class:

SubscriptionScheduleCreateParams.Phase

public static class SubscriptionScheduleCreateParams.Phase.Item
extends Object

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 SubscriptionScheduleCreateParams.Phase.InvoiceSettings.extraParams for the field documentation.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SubscriptionScheduleCreateParams.Phase.Item.BillingThresholds
static class	SubscriptionScheduleCreateParams.Phase.Item.Builder
static class	SubscriptionScheduleCreateParams.Phase.Item.PriceData	Required. Number of units that meets the billing threshold to advance the subscription to a new billing period (e.g., it takes 10 $5 units to meet a $50 monetary threshold)

Method Summary

Modifier and Type	Method	Description
static SubscriptionScheduleCreateParams.Phase.Item.Builder	builder()
Object	getBillingThresholds()	Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period.
Map<String,Object>	getExtraParams()	Map of extra parameters for custom features not available in this client library.
Map<String,String>	getMetadata()	Set of key-value pairs that you can attach to a configuration item.
String	getPlan()	The plan ID to subscribe to.
String	getPrice()	The ID of the price object.
SubscriptionScheduleCreateParams.Phase.Item.PriceData	getPriceData()	Data used to generate a new Price object inline.
Long	getQuantity()	Quantity for the given price.
Object	getTaxRates()	A list of Tax Rate ids.

Methods inherited from class java.lang.Object

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

Method Details

builder

public static SubscriptionScheduleCreateParams.Phase.Item.Builder builder()

getBillingThresholds

public Object getBillingThresholds()

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.

getExtraParams

public Map<String,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.

getMetadata

public Map<String,String> getMetadata()

Set of key-value pairs that you can attach to a configuration item. Metadata on a configuration item will update the underlying subscription item's metadata when the phase is entered, adding new keys and replacing existing keys. Individual keys in the subscription item's metadata can be unset by posting an empty value to them in the configuration item's metadata. To unset all keys in the subscription item's metadata, update the subscription item directly or unset every key individually from the configuration item's metadata.

getPlan

public String getPlan()

The plan ID to subscribe to. You may specify the same ID in plan and price.

getPrice

public String getPrice()

The ID of the price object.

getPriceData

public SubscriptionScheduleCreateParams.Phase.Item.PriceData getPriceData()

Data used to generate a new Price object inline.

getQuantity

public Long getQuantity()

Quantity for the given price. Can be set only if the price's usage_type is licensed and not metered.

getTaxRates

public Object getTaxRates()

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.