com.stripe.param

Class SubscriptionScheduleCreateParams.Phase.Builder

java.lang.Object

com.stripe.param.SubscriptionScheduleCreateParams.Phase.Builder

Enclosing class:

SubscriptionScheduleCreateParams.Phase

public static class SubscriptionScheduleCreateParams.Phase.Builder
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
SubscriptionScheduleCreateParams.Phase.Builder	addAllPlan(java.util.List<SubscriptionScheduleCreateParams.Phase.Plan> elements) Add all elements to `plans` list.
SubscriptionScheduleCreateParams.Phase.Builder	addPlan(SubscriptionScheduleCreateParams.Phase.Plan element) Add an element to `plans` list.
SubscriptionScheduleCreateParams.Phase	build() Finalize and obtain parameter instance from this builder.
SubscriptionScheduleCreateParams.Phase.Builder	putAllExtraParam(java.util.Map<java.lang.String,java.lang.Object> map) Add all map key/value pairs to `extraParams` map.
SubscriptionScheduleCreateParams.Phase.Builder	putExtraParam(java.lang.String key, java.lang.Object value) Add a key/value pair to `extraParams` map.
SubscriptionScheduleCreateParams.Phase.Builder	setApplicationFeePercent(java.math.BigDecimal applicationFeePercent) A non-negative decimal between 0 and 100, with at most two decimal places.
SubscriptionScheduleCreateParams.Phase.Builder	setCoupon(java.lang.String coupon) The identifier of the coupon to apply to this phase of the subscription schedule.
SubscriptionScheduleCreateParams.Phase.Builder	setDefaultTaxRates(EmptyParam defaultTaxRates) The tax rates that will apply to any phase that does not have `tax_rates` set.
SubscriptionScheduleCreateParams.Phase.Builder	setDefaultTaxRates(java.util.List<java.lang.String> defaultTaxRates) The tax rates that will apply to any phase that does not have `tax_rates` set.
SubscriptionScheduleCreateParams.Phase.Builder	setEndDate(java.lang.Long endDate) The date at which this phase of the subscription schedule ends.
SubscriptionScheduleCreateParams.Phase.Builder	setIterations(java.lang.Long iterations) Integer representing the multiplier applied to the plan interval.
SubscriptionScheduleCreateParams.Phase.Builder	setTaxPercent(java.math.BigDecimal taxPercent) A non-negative decimal (with at most four decimal places) between 0 and 100.
SubscriptionScheduleCreateParams.Phase.Builder	setTrial(java.lang.Boolean trial) If set to true the entire phase is counted as a trial and the customer will not be charged for any fees.
SubscriptionScheduleCreateParams.Phase.Builder	setTrialEnd(java.lang.Long trialEnd) Sets the phase to trialing from the start date to this date.

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 SubscriptionScheduleCreateParams.Phase build()

Finalize and obtain parameter instance from this builder.

setApplicationFeePercent

public SubscriptionScheduleCreateParams.Phase.Builder setApplicationFeePercent(java.math.BigDecimal applicationFeePercent)

A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice subtotal that will be transferred to the application owner's Stripe account. The request must be made with an OAuth key in order to set an application fee percentage. For more information, see the application fees [documentation](https://stripe.com/docs/connect/subscriptions#collecting-fees-on-subscriptions).

setCoupon

public SubscriptionScheduleCreateParams.Phase.Builder setCoupon(java.lang.String coupon)

The identifier of the coupon to apply to this phase of the subscription schedule.

setDefaultTaxRates

public SubscriptionScheduleCreateParams.Phase.Builder setDefaultTaxRates(EmptyParam defaultTaxRates)

The tax rates that will apply to any phase that does not have `tax_rates` set. Invoices created will have their `default_tax_rates` populated from the phase.

setDefaultTaxRates

public SubscriptionScheduleCreateParams.Phase.Builder setDefaultTaxRates(java.util.List<java.lang.String> defaultTaxRates)

The tax rates that will apply to any phase that does not have `tax_rates` set. Invoices created will have their `default_tax_rates` populated from the phase.

setEndDate

public SubscriptionScheduleCreateParams.Phase.Builder setEndDate(java.lang.Long endDate)

The date at which this phase of the subscription schedule ends. If set, `iterations` must not be set.

putExtraParam

public SubscriptionScheduleCreateParams.Phase.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 SubscriptionScheduleCreateParams.Phase.extraParams for the field documentation.

putAllExtraParam

public SubscriptionScheduleCreateParams.Phase.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 SubscriptionScheduleCreateParams.Phase.extraParams for the field documentation.

setIterations

public SubscriptionScheduleCreateParams.Phase.Builder setIterations(java.lang.Long iterations)

Integer representing the multiplier applied to the plan interval. For example, `iterations=2` applied to a plan with `interval=month` and `interval_count=3` results in a phase of duration `2 * 3 months = 6 months`. If set, `end_date` must not be set.

addPlan

public SubscriptionScheduleCreateParams.Phase.Builder addPlan(SubscriptionScheduleCreateParams.Phase.Plan element)

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

addAllPlan

public SubscriptionScheduleCreateParams.Phase.Builder addAllPlan(java.util.List<SubscriptionScheduleCreateParams.Phase.Plan> elements)

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

setTaxPercent

public SubscriptionScheduleCreateParams.Phase.Builder setTaxPercent(java.math.BigDecimal taxPercent)

A non-negative decimal (with at most four decimal places) between 0 and 100. This represents the percentage of the subscription invoice subtotal that will be calculated and added as tax to the final amount in each billing period during thise phase of the schedule. For example, a plan which charges $10/month with a `tax_percent` of `20.0` will charge $12 per invoice. To unset a previously-set value, pass an empty string. This field has been deprecated and will be removed in a future API version, for further information view the [migration docs](https://stripe.com/docs/billing/migration/taxes) for `tax_rates`.

setTrial

public SubscriptionScheduleCreateParams.Phase.Builder setTrial(java.lang.Boolean trial)

If set to true the entire phase is counted as a trial and the customer will not be charged for any fees.

setTrialEnd

public SubscriptionScheduleCreateParams.Phase.Builder setTrialEnd(java.lang.Long trialEnd)

Sets the phase to trialing from the start date to this date. Must be before the phase end date, can not be combined with `trial`