com.stripe.param

Class SubscriptionScheduleCreateParams.Phase.Plan

java.lang.Object

com.stripe.param.SubscriptionScheduleCreateParams.Phase.Plan

Enclosing class:

SubscriptionScheduleCreateParams.Phase

public static class SubscriptionScheduleCreateParams.Phase.Plan
extends java.lang.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 and Description
static class	SubscriptionScheduleCreateParams.Phase.Plan.BillingThresholds
static class	SubscriptionScheduleCreateParams.Phase.Plan.Builder

Method Summary

Modifier and Type	Method and Description
static SubscriptionScheduleCreateParams.Phase.Plan.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.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	getPlan() The plan ID to subscribe to.
java.lang.Long	getQuantity() Quantity for the given plan.
java.lang.Object	getTaxRates() A list of [Tax Rate](https://stripe.com/docs/api/tax_rates) ids.

Methods inherited from class java.lang.Object

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

Method Detail

builder

public static SubscriptionScheduleCreateParams.Phase.Plan.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.

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.

getPlan

public java.lang.String getPlan()

The plan ID to subscribe to.

getQuantity

public java.lang.Long getQuantity()

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

getTaxRates

public java.lang.Object getTaxRates()

A list of [Tax Rate](https://stripe.com/docs/api/tax_rates) ids. These Tax Rates will override the [`default_tax_rates`](https://stripe.com/docs/api/subscriptions/create#create_subscription-default_tax_rates) on the Subscription. When updating, pass an empty string to remove previously-defined tax rates.