Package com.stripe.param

Class InvoiceUpcomingParams.SubscriptionItem

java.lang.Object

com.stripe.param.InvoiceUpcomingParams.SubscriptionItem

Enclosing class:

InvoiceUpcomingParams

public static class InvoiceUpcomingParams.SubscriptionItem
extends java.lang.Object

Same as unit_amount, but accepts a decimal value in %s with at most 12 decimal places. Only one of unit_amount and unit_amount_decimal can be set.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	InvoiceUpcomingParams.SubscriptionItem.BillingThresholds
static class	InvoiceUpcomingParams.SubscriptionItem.Builder
static class	InvoiceUpcomingParams.SubscriptionItem.PriceData	Usage threshold that triggers the subscription to advance to a new billing period.

Method Summary

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

builder

public static InvoiceUpcomingParams.SubscriptionItem.Builder builder()

getBillingThresholds

public java.lang.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 java.lang.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 java.lang.Boolean getDeleted()

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

getExtraParams

public java.util.Map<java.lang.String,java.lang.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 java.lang.String getId()

Subscription item to update.

getMetadata

public java.lang.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 java.lang.String getPlan()

Plan ID for this item, as a string.

getPrice

public java.lang.String getPrice()

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

getPriceData

public InvoiceUpcomingParams.SubscriptionItem.PriceData getPriceData()

Data used to generate a new Price object inline.

getQuantity

public java.lang.Long getQuantity()

Quantity for this item.

getTaxRates

public java.lang.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.