Package com.stripe.param

Class InvoiceUpcomingParams.SubscriptionDetails.Item

java.lang.Object

com.stripe.param.InvoiceUpcomingParams.SubscriptionDetails.Item

Enclosing class:

InvoiceUpcomingParams.SubscriptionDetails

public static class InvoiceUpcomingParams.SubscriptionDetails.Item
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	InvoiceUpcomingParams.SubscriptionDetails.Item.BillingThresholds
static class	InvoiceUpcomingParams.SubscriptionDetails.Item.Builder
static class	InvoiceUpcomingParams.SubscriptionDetails.Item.Discount	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)
static class	InvoiceUpcomingParams.SubscriptionDetails.Item.PriceData	ID of the promotion code to create a new discount for.

Method Summary

Modifier and Type	Method	Description
static InvoiceUpcomingParams.SubscriptionDetails.Item.Builder	builder()
Object	getBillingThresholds()	Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period.
Boolean	getClearUsage()	Delete all usage for a given subscription item.
Boolean	getDeleted()	A flag that, if set to true, will delete the specified item.
Object	getDiscounts()	The coupons to redeem into discounts for the subscription item.
Map<String,Object>	getExtraParams()	Map of extra parameters for custom features not available in this client library.
String	getId()	Subscription item to update.
Object	getMetadata()	Set of key-value pairs that you can attach to an object.
String	getPlan()	Plan ID for this item, as a string.
String	getPrice()	The ID of the price object.
InvoiceUpcomingParams.SubscriptionDetails.Item.PriceData	getPriceData()	Data used to generate a new Price object inline.
Long	getQuantity()	Quantity for this item.
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 InvoiceUpcomingParams.SubscriptionDetails.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.

getClearUsage

public Boolean getClearUsage()

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.

getDeleted

public Boolean getDeleted()

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

getDiscounts

public Object getDiscounts()

The coupons to redeem into discounts for the subscription item.

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.

getId

public String getId()

Subscription item to update.

getMetadata

public Object getMetadata()

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.

getPlan

public String getPlan()

Plan ID for this item, as a string.

getPrice

public String getPrice()

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.

getPriceData

public InvoiceUpcomingParams.SubscriptionDetails.Item.PriceData getPriceData()

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

getQuantity

public Long getQuantity()

Quantity for this item.

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.