Package 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 Object

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
SubscriptionScheduleCreateParams.Phase.Builder	addAddInvoiceItem(SubscriptionScheduleCreateParams.Phase.AddInvoiceItem element)	Add an element to `addInvoiceItems` list.
SubscriptionScheduleCreateParams.Phase.Builder	addAllAddInvoiceItem(List<SubscriptionScheduleCreateParams.Phase.AddInvoiceItem> elements)	Add all elements to `addInvoiceItems` list.
SubscriptionScheduleCreateParams.Phase.Builder	addAllDefaultTaxRate(List<String> elements)	Add all elements to `defaultTaxRates` list.
SubscriptionScheduleCreateParams.Phase.Builder	addAllDiscount(List<SubscriptionScheduleCreateParams.Phase.Discount> elements)	Add all elements to `discounts` list.
SubscriptionScheduleCreateParams.Phase.Builder	addAllItem(List<SubscriptionScheduleCreateParams.Phase.Item> elements)	Add all elements to `items` list.
SubscriptionScheduleCreateParams.Phase.Builder	addDefaultTaxRate(String element)	Add an element to `defaultTaxRates` list.
SubscriptionScheduleCreateParams.Phase.Builder	addDiscount(SubscriptionScheduleCreateParams.Phase.Discount element)	Add an element to `discounts` list.
SubscriptionScheduleCreateParams.Phase.Builder	addItem(SubscriptionScheduleCreateParams.Phase.Item element)	Add an element to `items` list.
SubscriptionScheduleCreateParams.Phase	build()	Finalize and obtain parameter instance from this builder.
SubscriptionScheduleCreateParams.Phase.Builder	putAllExtraParam(Map<String,Object> map)	Add all map key/value pairs to `extraParams` map.
SubscriptionScheduleCreateParams.Phase.Builder	putAllMetadata(Map<String,String> map)	Add all map key/value pairs to `metadata` map.
SubscriptionScheduleCreateParams.Phase.Builder	putExtraParam(String key, Object value)	Add a key/value pair to `extraParams` map.
SubscriptionScheduleCreateParams.Phase.Builder	putMetadata(String key, String value)	Add a key/value pair to `metadata` map.
SubscriptionScheduleCreateParams.Phase.Builder	setApplicationFeePercent(BigDecimal applicationFeePercent)	A non-negative decimal between 0 and 100, with at most two decimal places.
SubscriptionScheduleCreateParams.Phase.Builder	setAutomaticTax(SubscriptionScheduleCreateParams.Phase.AutomaticTax automaticTax)	Automatic tax settings for this phase.
SubscriptionScheduleCreateParams.Phase.Builder	setBillingCycleAnchor(SubscriptionScheduleCreateParams.Phase.BillingCycleAnchor billingCycleAnchor)	Can be set to phase_start to set the anchor to the start of the phase or automatic to automatically change it if needed.
SubscriptionScheduleCreateParams.Phase.Builder	setBillingThresholds(EmptyParam billingThresholds)	Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period.
SubscriptionScheduleCreateParams.Phase.Builder	setBillingThresholds(SubscriptionScheduleCreateParams.Phase.BillingThresholds billingThresholds)	Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period.
SubscriptionScheduleCreateParams.Phase.Builder	setCollectionMethod(SubscriptionScheduleCreateParams.Phase.CollectionMethod collectionMethod)	Either charge_automatically, or send_invoice.
SubscriptionScheduleCreateParams.Phase.Builder	setCoupon(String coupon)	The ID of the coupon to apply to this phase of the subscription schedule.
SubscriptionScheduleCreateParams.Phase.Builder	setCurrency(String currency)	Three-letter ISO currency code, in lowercase.
SubscriptionScheduleCreateParams.Phase.Builder	setDefaultPaymentMethod(String defaultPaymentMethod)	ID of the default payment method for the subscription schedule.
SubscriptionScheduleCreateParams.Phase.Builder	setDefaultTaxRates(EmptyParam defaultTaxRates)	A list of Tax Rate ids.
SubscriptionScheduleCreateParams.Phase.Builder	setDefaultTaxRates(List<String> defaultTaxRates)	A list of Tax Rate ids.
SubscriptionScheduleCreateParams.Phase.Builder	setDescription(EmptyParam description)	Subscription description, meant to be displayable to the customer.
SubscriptionScheduleCreateParams.Phase.Builder	setDescription(String description)	Subscription description, meant to be displayable to the customer.
SubscriptionScheduleCreateParams.Phase.Builder	setDiscounts(EmptyParam discounts)	The coupons to redeem into discounts for the schedule phase.
SubscriptionScheduleCreateParams.Phase.Builder	setDiscounts(List<SubscriptionScheduleCreateParams.Phase.Discount> discounts)	The coupons to redeem into discounts for the schedule phase.
SubscriptionScheduleCreateParams.Phase.Builder	setEndDate(Long endDate)	The date at which this phase of the subscription schedule ends.
SubscriptionScheduleCreateParams.Phase.Builder	setInvoiceSettings(SubscriptionScheduleCreateParams.Phase.InvoiceSettings invoiceSettings)	All invoices will be billed using the specified settings.
SubscriptionScheduleCreateParams.Phase.Builder	setIterations(Long iterations)	Integer representing the multiplier applied to the price interval.
SubscriptionScheduleCreateParams.Phase.Builder	setOnBehalfOf(String onBehalfOf)	The account on behalf of which to charge, for each of the associated subscription's invoices.
SubscriptionScheduleCreateParams.Phase.Builder	setProrationBehavior(SubscriptionScheduleCreateParams.Phase.ProrationBehavior prorationBehavior)	Whether the subscription schedule will create prorations when transitioning to this phase.
SubscriptionScheduleCreateParams.Phase.Builder	setTransferData(SubscriptionScheduleCreateParams.Phase.TransferData transferData)	The data with which to automatically create a Transfer for each of the associated subscription's invoices.
SubscriptionScheduleCreateParams.Phase.Builder	setTrial(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(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 Details

Builder

public Builder()

Method Details

build

public SubscriptionScheduleCreateParams.Phase build()

Finalize and obtain parameter instance from this builder.

addAddInvoiceItem

public SubscriptionScheduleCreateParams.Phase.Builder addAddInvoiceItem(SubscriptionScheduleCreateParams.Phase.AddInvoiceItem element)

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

addAllAddInvoiceItem

public SubscriptionScheduleCreateParams.Phase.Builder addAllAddInvoiceItem(List<SubscriptionScheduleCreateParams.Phase.AddInvoiceItem> elements)

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

setApplicationFeePercent

public SubscriptionScheduleCreateParams.Phase.Builder setApplicationFeePercent(BigDecimal applicationFeePercent)

A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the application owner's Stripe account. The request must be made by a platform account on a connected account in order to set an application fee percentage. For more information, see the application fees documentation.

setAutomaticTax

public SubscriptionScheduleCreateParams.Phase.Builder setAutomaticTax(SubscriptionScheduleCreateParams.Phase.AutomaticTax automaticTax)

Automatic tax settings for this phase.

setBillingCycleAnchor

public SubscriptionScheduleCreateParams.Phase.Builder setBillingCycleAnchor(SubscriptionScheduleCreateParams.Phase.BillingCycleAnchor billingCycleAnchor)

Can be set to phase_start to set the anchor to the start of the phase or automatic to automatically change it if needed. Cannot be set to phase_start if this phase specifies a trial. For more information, see the billing cycle documentation.

setBillingThresholds

public SubscriptionScheduleCreateParams.Phase.Builder setBillingThresholds(SubscriptionScheduleCreateParams.Phase.BillingThresholds billingThresholds)

Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. Pass an empty string to remove previously-defined thresholds.

setBillingThresholds

public SubscriptionScheduleCreateParams.Phase.Builder setBillingThresholds(EmptyParam billingThresholds)

Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. Pass an empty string to remove previously-defined thresholds.

setCollectionMethod

public SubscriptionScheduleCreateParams.Phase.Builder setCollectionMethod(SubscriptionScheduleCreateParams.Phase.CollectionMethod collectionMethod)

Either charge_automatically, or send_invoice. When charging automatically, Stripe will attempt to pay the underlying subscription at the end of each billing cycle using the default source attached to the customer. When sending an invoice, Stripe will email your customer an invoice with payment instructions and mark the subscription as active. Defaults to charge_automatically on creation.

setCoupon

public SubscriptionScheduleCreateParams.Phase.Builder setCoupon(String coupon)

The ID of the coupon to apply to this phase of the subscription schedule. This field has been deprecated and will be removed in a future API version. Use discounts instead.

setCurrency

public SubscriptionScheduleCreateParams.Phase.Builder setCurrency(String currency)

Three-letter ISO currency code, in lowercase. Must be a supported currency.

setDefaultPaymentMethod

public SubscriptionScheduleCreateParams.Phase.Builder setDefaultPaymentMethod(String defaultPaymentMethod)

ID of the default payment method for the subscription schedule. It must belong to the customer associated with the subscription schedule. If not set, invoices will use the default payment method in the customer's invoice settings.

addDefaultTaxRate

public SubscriptionScheduleCreateParams.Phase.Builder addDefaultTaxRate(String element)

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

addAllDefaultTaxRate

public SubscriptionScheduleCreateParams.Phase.Builder addAllDefaultTaxRate(List<String> elements)

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

setDefaultTaxRates

public SubscriptionScheduleCreateParams.Phase.Builder setDefaultTaxRates(EmptyParam defaultTaxRates)

A list of Tax Rate ids. These Tax Rates will set the Subscription's default_tax_rates, which means they will be the Invoice's default_tax_rates for any Invoices issued by the Subscription during this Phase.

setDefaultTaxRates

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

A list of Tax Rate ids. These Tax Rates will set the Subscription's default_tax_rates, which means they will be the Invoice's default_tax_rates for any Invoices issued by the Subscription during this Phase.

setDescription

public SubscriptionScheduleCreateParams.Phase.Builder setDescription(String description)

Subscription description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription for rendering in Stripe surfaces and certain local payment methods UIs.

setDescription

public SubscriptionScheduleCreateParams.Phase.Builder setDescription(EmptyParam description)

Subscription description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription for rendering in Stripe surfaces and certain local payment methods UIs.

addDiscount

public SubscriptionScheduleCreateParams.Phase.Builder addDiscount(SubscriptionScheduleCreateParams.Phase.Discount element)

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

addAllDiscount

public SubscriptionScheduleCreateParams.Phase.Builder addAllDiscount(List<SubscriptionScheduleCreateParams.Phase.Discount> elements)

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

setDiscounts

public SubscriptionScheduleCreateParams.Phase.Builder setDiscounts(EmptyParam discounts)

The coupons to redeem into discounts for the schedule phase. If not specified, inherits the discount from the subscription's customer. Pass an empty string to avoid inheriting any discounts.

setDiscounts

public SubscriptionScheduleCreateParams.Phase.Builder setDiscounts(List<SubscriptionScheduleCreateParams.Phase.Discount> discounts)

The coupons to redeem into discounts for the schedule phase. If not specified, inherits the discount from the subscription's customer. Pass an empty string to avoid inheriting any discounts.

setEndDate

public SubscriptionScheduleCreateParams.Phase.Builder setEndDate(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(String key,
 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(Map<String,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.

setInvoiceSettings

public SubscriptionScheduleCreateParams.Phase.Builder setInvoiceSettings(SubscriptionScheduleCreateParams.Phase.InvoiceSettings invoiceSettings)

All invoices will be billed using the specified settings.

addItem

public SubscriptionScheduleCreateParams.Phase.Builder addItem(SubscriptionScheduleCreateParams.Phase.Item element)

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

addAllItem

public SubscriptionScheduleCreateParams.Phase.Builder addAllItem(List<SubscriptionScheduleCreateParams.Phase.Item> elements)

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

setIterations

public SubscriptionScheduleCreateParams.Phase.Builder setIterations(Long iterations)

Integer representing the multiplier applied to the price interval. For example, iterations=2 applied to a price 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.

putMetadata

public SubscriptionScheduleCreateParams.Phase.Builder putMetadata(String key,
 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 SubscriptionScheduleCreateParams.Phase.metadata for the field documentation.

putAllMetadata

public SubscriptionScheduleCreateParams.Phase.Builder putAllMetadata(Map<String,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 SubscriptionScheduleCreateParams.Phase.metadata for the field documentation.

setOnBehalfOf

public SubscriptionScheduleCreateParams.Phase.Builder setOnBehalfOf(String onBehalfOf)

The account on behalf of which to charge, for each of the associated subscription's invoices.

setProrationBehavior

public SubscriptionScheduleCreateParams.Phase.Builder setProrationBehavior(SubscriptionScheduleCreateParams.Phase.ProrationBehavior prorationBehavior)

Whether the subscription schedule will create prorations when transitioning to this phase. The default value is create_prorations. This setting controls prorations when a phase is started asynchronously and it is persisted as a field on the phase. It's different from the request-level proration_behavior parameter which controls what happens if the update request affects the billing configuration of the current phase.

setTransferData

public SubscriptionScheduleCreateParams.Phase.Builder setTransferData(SubscriptionScheduleCreateParams.Phase.TransferData transferData)

The data with which to automatically create a Transfer for each of the associated subscription's invoices.

setTrial

public SubscriptionScheduleCreateParams.Phase.Builder setTrial(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(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