com.stripe.param

Class PriceCreateParams.Recurring

java.lang.Object

com.stripe.param.PriceCreateParams.Recurring

Enclosing class:

PriceCreateParams

public static class PriceCreateParams.Recurring
extends java.lang.Object

A label that represents units of this product in Stripe and on customers’ receipts and invoices. When set, this will be included in associated invoice line item descriptions.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PriceCreateParams.Recurring.AggregateUsage
static class	PriceCreateParams.Recurring.Builder
static class	PriceCreateParams.Recurring.Interval
static class	PriceCreateParams.Recurring.UsageType

Method Summary

Modifier and Type	Method and Description
static PriceCreateParams.Recurring.Builder	builder()
PriceCreateParams.Recurring.AggregateUsage	getAggregateUsage() Specifies a usage aggregation strategy for prices of usage_type=metered.
java.util.Map<java.lang.String,java.lang.Object>	getExtraParams() Map of extra parameters for custom features not available in this client library.
PriceCreateParams.Recurring.Interval	getInterval() Specifies billing frequency.
java.lang.Long	getIntervalCount() The number of intervals between subscription billings.
java.lang.Long	getTrialPeriodDays() Default number of trial days when subscribing a customer to this price using trial_from_plan=true.
PriceCreateParams.Recurring.UsageType	getUsageType() Configures how the quantity per period should be determined.

Methods inherited from class java.lang.Object

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

Method Detail

builder

public static PriceCreateParams.Recurring.Builder builder()

getAggregateUsage

public PriceCreateParams.Recurring.AggregateUsage getAggregateUsage()

Specifies a usage aggregation strategy for prices of usage_type=metered. Allowed values are sum for summing up all usage during a period, last_during_period for using the last usage record reported within a period, last_ever for using the last usage record ever (across period bounds) or max which uses the usage record with the maximum reported usage during a period. Defaults to sum.

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.

getInterval

public PriceCreateParams.Recurring.Interval getInterval()

Specifies billing frequency. Either day, week, month or year.

getIntervalCount

public java.lang.Long getIntervalCount()

The number of intervals between subscription billings. For example, interval=month and interval_count=3 bills every 3 months. Maximum of one year interval allowed (1 year, 12 months, or 52 weeks).

getTrialPeriodDays

public java.lang.Long getTrialPeriodDays()

Default number of trial days when subscribing a customer to this price using trial_from_plan=true.

getUsageType

public PriceCreateParams.Recurring.UsageType getUsageType()

Configures how the quantity per period should be determined. Can be either metered or licensed. licensed automatically bills the quantity set when adding it to a subscription. metered aggregates the total usage based on usage records. Defaults to licensed.