SubscriptionScheduleCreateParams.Phase.Builder (stripe-java 19.37.0 API)

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

Constructors
Constructor and Description
`Builder()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`SubscriptionScheduleCreateParams.Phase.Builder`	`addAddInvoiceItem(SubscriptionScheduleCreateParams.Phase.AddInvoiceItem element)` Add an element to `addInvoiceItems` list.
`SubscriptionScheduleCreateParams.Phase.Builder`	`addAllAddInvoiceItem(java.util.List<SubscriptionScheduleCreateParams.Phase.AddInvoiceItem> elements)` Add all elements to `addInvoiceItems` list.
`SubscriptionScheduleCreateParams.Phase.Builder`	`addAllDefaultTaxRate(java.util.List<java.lang.String> elements)` Add all elements to `defaultTaxRates` list.
`SubscriptionScheduleCreateParams.Phase.Builder`	`addAllPlan(java.util.List<SubscriptionScheduleCreateParams.Phase.Plan> elements)` Add all elements to `plans` list.
`SubscriptionScheduleCreateParams.Phase.Builder`	`addDefaultTaxRate(java.lang.String element)` Add an element to `defaultTaxRates` 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`	`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(java.lang.String coupon)` The identifier of the coupon to apply to this phase of the subscription schedule.
`SubscriptionScheduleCreateParams.Phase.Builder`	`setDefaultPaymentMethod(java.lang.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(java.util.List<java.lang.String> defaultTaxRates)` A list of Tax Rate ids.
`SubscriptionScheduleCreateParams.Phase.Builder`	`setEndDate(java.lang.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(java.lang.Long iterations)` Integer representing the multiplier applied to the price interval.
`SubscriptionScheduleCreateParams.Phase.Builder`	`setProrationBehavior(SubscriptionScheduleCreateParams.Phase.ProrationBehavior prorationBehavior)` If a subscription schedule will create prorations when transitioning to this phase.
`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`	`setTransferData(SubscriptionScheduleCreateParams.Phase.TransferData transferData)` The data with which to automatically create a Transfer for each of the subscription's invoices.
`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.
  - 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(java.util.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(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 by a platform account on a connected account in order to set an application fee percentage. For more information, see the application fees documentation.
  - 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. Defaults to charge_automatically on creation.
  - setCoupon
```
public SubscriptionScheduleCreateParams.Phase.Builder setCoupon(java.lang.String coupon)
```
    The identifier of the coupon to apply to this phase of the subscription schedule.
  - setDefaultPaymentMethod
```
public SubscriptionScheduleCreateParams.Phase.Builder setDefaultPaymentMethod(java.lang.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(java.lang.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(java.util.List<java.lang.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(java.util.List<java.lang.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.
  - 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.
  - setInvoiceSettings
```
public SubscriptionScheduleCreateParams.Phase.Builder setInvoiceSettings(SubscriptionScheduleCreateParams.Phase.InvoiceSettings invoiceSettings)
```
    All invoices will be billed using the specified settings.
  - setIterations
```
public SubscriptionScheduleCreateParams.Phase.Builder setIterations(java.lang.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.
  - 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.
  - setProrationBehavior
```
public SubscriptionScheduleCreateParams.Phase.Builder setProrationBehavior(SubscriptionScheduleCreateParams.Phase.ProrationBehavior prorationBehavior)
```
    If a subscription schedule will create prorations when transitioning to this phase. Possible values are create_prorations or none, and the default value is create_prorations. See Prorations.
  - 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 price 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 for tax_rates.
  - setTransferData
```
public SubscriptionScheduleCreateParams.Phase.Builder setTransferData(SubscriptionScheduleCreateParams.Phase.TransferData transferData)
```
    The data with which to automatically create a Transfer for each of the subscription's invoices.
  - 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

Class SubscriptionScheduleCreateParams.Phase.Builder

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Builder

Method Detail

build

addAddInvoiceItem

addAllAddInvoiceItem

setApplicationFeePercent

setBillingCycleAnchor

setBillingThresholds

setBillingThresholds

setCollectionMethod

setCoupon

setDefaultPaymentMethod

addDefaultTaxRate

addAllDefaultTaxRate

setDefaultTaxRates

setDefaultTaxRates

setEndDate

putExtraParam

putAllExtraParam

setInvoiceSettings

setIterations

addPlan

addAllPlan

setProrationBehavior

setTaxPercent

setTransferData

setTrial

setTrialEnd