com.stripe.param

Class PlanCreateParams.Builder

java.lang.Object

com.stripe.param.PlanCreateParams.Builder

Enclosing class:

PlanCreateParams

public static class PlanCreateParams.Builder
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
PlanCreateParams.Builder	addAllExpand(java.util.List<java.lang.String> elements) Add all elements to `expand` list.
PlanCreateParams.Builder	addAllTier(java.util.List<PlanCreateParams.Tier> elements) Add all elements to `tiers` list.
PlanCreateParams.Builder	addExpand(java.lang.String element) Add an element to `expand` list.
PlanCreateParams.Builder	addTier(PlanCreateParams.Tier element) Add an element to `tiers` list.
PlanCreateParams	build() Finalize and obtain parameter instance from this builder.
PlanCreateParams.Builder	putAllExtraParam(java.util.Map<java.lang.String,java.lang.Object> map) Add all map key/value pairs to `extraParams` map.
PlanCreateParams.Builder	putAllMetadata(java.util.Map<java.lang.String,java.lang.String> map) Add all map key/value pairs to `metadata` map.
PlanCreateParams.Builder	putExtraParam(java.lang.String key, java.lang.Object value) Add a key/value pair to `extraParams` map.
PlanCreateParams.Builder	putMetadata(java.lang.String key, java.lang.String value) Add a key/value pair to `metadata` map.
PlanCreateParams.Builder	setActive(java.lang.Boolean active) Whether the plan is currently available for new subscriptions.
PlanCreateParams.Builder	setAggregateUsage(PlanCreateParams.AggregateUsage aggregateUsage) Specifies a usage aggregation strategy for plans of `usage_type=metered`.
PlanCreateParams.Builder	setAmount(java.lang.Long amount) A positive integer in %s (or 0 for a free plan) representing how much to charge on a recurring basis.
PlanCreateParams.Builder	setBillingScheme(PlanCreateParams.BillingScheme billingScheme) Describes how to compute the price per period.
PlanCreateParams.Builder	setCurrency(java.lang.String currency) Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase.
PlanCreateParams.Builder	setId(java.lang.String id) An identifier randomly generated by Stripe.
PlanCreateParams.Builder	setInterval(PlanCreateParams.Interval interval) Specifies billing frequency.
PlanCreateParams.Builder	setIntervalCount(java.lang.Long intervalCount) The number of intervals between subscription billings.
PlanCreateParams.Builder	setNickname(java.lang.String nickname) A brief description of the plan, hidden from customers.
PlanCreateParams.Builder	setProduct(PlanCreateParams.Product product)
PlanCreateParams.Builder	setProduct(java.lang.String product)
PlanCreateParams.Builder	setTiersMode(PlanCreateParams.TiersMode tiersMode) Defines if the tiering price should be `graduated` or `volume` based.
PlanCreateParams.Builder	setTransformUsage(PlanCreateParams.TransformUsage transformUsage) Apply a transformation to the reported usage or set quantity before computing the billed price.
PlanCreateParams.Builder	setTrialPeriodDays(java.lang.Long trialPeriodDays) Default number of trial days when subscribing a customer to this plan using [`trial_from_plan=true`](https://stripe.com/docs/api#create_subscription-trial_from_plan).
PlanCreateParams.Builder	setUsageType(PlanCreateParams.UsageType usageType) Configures how the quantity per period should be determined, can be either `metered` or `licensed`.

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

build

public PlanCreateParams build()

Finalize and obtain parameter instance from this builder.

setActive

public PlanCreateParams.Builder setActive(java.lang.Boolean active)

Whether the plan is currently available for new subscriptions. Defaults to `true`.

setAggregateUsage

public PlanCreateParams.Builder setAggregateUsage(PlanCreateParams.AggregateUsage aggregateUsage)

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

setAmount

public PlanCreateParams.Builder setAmount(java.lang.Long amount)

A positive integer in %s (or 0 for a free plan) representing how much to charge on a recurring basis.

setBillingScheme

public PlanCreateParams.Builder setBillingScheme(PlanCreateParams.BillingScheme billingScheme)

Describes how to compute the price per period. Either `per_unit` or `tiered`. `per_unit` indicates that the fixed amount (specified in `amount`) will be charged per unit in `quantity` (for plans with `usage_type=licensed`), or per unit of total usage (for plans with `usage_type=metered`). `tiered` indicates that the unit pricing will be computed using a tiering strategy as defined using the `tiers` and `tiers_mode` attributes.

setCurrency

public PlanCreateParams.Builder setCurrency(java.lang.String currency)

Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).

addExpand

public PlanCreateParams.Builder addExpand(java.lang.String element)

Add an element to `expand` list. A list is initialized for the first `add/addAll` call, and subsequent calls adds additional elements to the original list. See PlanCreateParams.expand for the field documentation.

addAllExpand

public PlanCreateParams.Builder addAllExpand(java.util.List<java.lang.String> elements)

Add all elements to `expand` list. A list is initialized for the first `add/addAll` call, and subsequent calls adds additional elements to the original list. See PlanCreateParams.expand for the field documentation.

putExtraParam

public PlanCreateParams.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. See PlanCreateParams.extraParams for the field documentation.

putAllExtraParam

public PlanCreateParams.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. See PlanCreateParams.extraParams for the field documentation.

setId

public PlanCreateParams.Builder setId(java.lang.String id)

An identifier randomly generated by Stripe. Used to identify this plan when subscribing a customer. You can optionally override this ID, but the ID must be unique across all plans in your Stripe account. You can, however, use the same plan ID in both live and test modes.

setInterval

public PlanCreateParams.Builder setInterval(PlanCreateParams.Interval interval)

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

setIntervalCount

public PlanCreateParams.Builder setIntervalCount(java.lang.Long intervalCount)

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).

putMetadata

public PlanCreateParams.Builder putMetadata(java.lang.String key,
                                            java.lang.String value)

Add a key/value pair to `metadata` map. A map is initialized for the first `put/putAll` call, and subsequent calls add additional key/value pairs to the original map. See PlanCreateParams.metadata for the field documentation.

putAllMetadata

public PlanCreateParams.Builder putAllMetadata(java.util.Map<java.lang.String,java.lang.String> map)

Add all map key/value pairs to `metadata` map. A map is initialized for the first `put/putAll` call, and subsequent calls add additional key/value pairs to the original map. See PlanCreateParams.metadata for the field documentation.

setNickname

public PlanCreateParams.Builder setNickname(java.lang.String nickname)

A brief description of the plan, hidden from customers.

setProduct

public PlanCreateParams.Builder setProduct(PlanCreateParams.Product product)

setProduct

public PlanCreateParams.Builder setProduct(java.lang.String product)

addTier

public PlanCreateParams.Builder addTier(PlanCreateParams.Tier element)

Add an element to `tiers` list. A list is initialized for the first `add/addAll` call, and subsequent calls adds additional elements to the original list. See PlanCreateParams.tiers for the field documentation.

addAllTier

public PlanCreateParams.Builder addAllTier(java.util.List<PlanCreateParams.Tier> elements)

Add all elements to `tiers` list. A list is initialized for the first `add/addAll` call, and subsequent calls adds additional elements to the original list. See PlanCreateParams.tiers for the field documentation.

setTiersMode

public PlanCreateParams.Builder setTiersMode(PlanCreateParams.TiersMode tiersMode)

Defines if the tiering price should be `graduated` or `volume` based. In `volume`-based tiering, the maximum quantity within a period determines the per unit price, in `graduated` tiering pricing can successively change as the quantity grows.

setTransformUsage

public PlanCreateParams.Builder setTransformUsage(PlanCreateParams.TransformUsage transformUsage)

Apply a transformation to the reported usage or set quantity before computing the billed price. Cannot be combined with `tiers`.

setTrialPeriodDays

public PlanCreateParams.Builder setTrialPeriodDays(java.lang.Long trialPeriodDays)

Default number of trial days when subscribing a customer to this plan using [`trial_from_plan=true`](https://stripe.com/docs/api#create_subscription-trial_from_plan).

setUsageType

public PlanCreateParams.Builder setUsageType(PlanCreateParams.UsageType usageType)

Configures how the quantity per period should be determined, can be either `metered` or `licensed`. `licensed` will automatically bill the `quantity` set for a plan when adding it to a subscription, `metered` will aggregate the total usage based on usage records. Defaults to `licensed`.