Package com.stripe.param
Class PriceCreateParams.Recurring.Builder
- java.lang.Object
-
- com.stripe.param.PriceCreateParams.Recurring.Builder
-
- Enclosing class:
- PriceCreateParams.Recurring
public static class PriceCreateParams.Recurring.Builder extends java.lang.Object
-
-
Constructor Summary
Constructors Constructor Description Builder()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description PriceCreateParams.Recurring
build()
Finalize and obtain parameter instance from this builder.PriceCreateParams.Recurring.Builder
putAllExtraParam(java.util.Map<java.lang.String,java.lang.Object> map)
Add all map key/value pairs to `extraParams` map.PriceCreateParams.Recurring.Builder
putExtraParam(java.lang.String key, java.lang.Object value)
Add a key/value pair to `extraParams` map.PriceCreateParams.Recurring.Builder
setAggregateUsage(PriceCreateParams.Recurring.AggregateUsage aggregateUsage)
Specifies a usage aggregation strategy for prices ofusage_type=metered
.PriceCreateParams.Recurring.Builder
setInterval(PriceCreateParams.Recurring.Interval interval)
Specifies billing frequency.PriceCreateParams.Recurring.Builder
setIntervalCount(java.lang.Long intervalCount)
The number of intervals between subscription billings.PriceCreateParams.Recurring.Builder
setTrialPeriodDays(java.lang.Long trialPeriodDays)
Default number of trial days when subscribing a customer to this price usingtrial_from_plan=true
.PriceCreateParams.Recurring.Builder
setUsageType(PriceCreateParams.Recurring.UsageType usageType)
Configures how the quantity per period should be determined.
-
-
-
Method Detail
-
build
public PriceCreateParams.Recurring build()
Finalize and obtain parameter instance from this builder.
-
setAggregateUsage
public PriceCreateParams.Recurring.Builder setAggregateUsage(PriceCreateParams.Recurring.AggregateUsage aggregateUsage)
Specifies a usage aggregation strategy for prices ofusage_type=metered
. Allowed values aresum
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) ormax
which uses the usage record with the maximum reported usage during a period. Defaults tosum
.
-
putExtraParam
public PriceCreateParams.Recurring.Builder putExtraParam(java.lang.String key, java.lang.Object value)
Add a key/value pair 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. SeePriceCreateParams.Recurring.extraParams
for the field documentation.
-
putAllExtraParam
public PriceCreateParams.Recurring.Builder putAllExtraParam(java.util.Map<java.lang.String,java.lang.Object> map)
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. SeePriceCreateParams.Recurring.extraParams
for the field documentation.
-
setInterval
public PriceCreateParams.Recurring.Builder setInterval(PriceCreateParams.Recurring.Interval interval)
Specifies billing frequency. Eitherday
,week
,month
oryear
.
-
setIntervalCount
public PriceCreateParams.Recurring.Builder setIntervalCount(java.lang.Long intervalCount)
The number of intervals between subscription billings. For example,interval=month
andinterval_count=3
bills every 3 months. Maximum of one year interval allowed (1 year, 12 months, or 52 weeks).
-
setTrialPeriodDays
public PriceCreateParams.Recurring.Builder setTrialPeriodDays(java.lang.Long trialPeriodDays)
Default number of trial days when subscribing a customer to this price usingtrial_from_plan=true
.
-
setUsageType
public PriceCreateParams.Recurring.Builder setUsageType(PriceCreateParams.Recurring.UsageType usageType)
Configures how the quantity per period should be determined. Can be eithermetered
orlicensed
.licensed
automatically bills thequantity
set when adding it to a subscription.metered
aggregates the total usage based on usage records. Defaults tolicensed
.
-
-