SubscriptionScheduleCreateParams.Phase (stripe-java 14.0.0 API)

java.lang.Object
- com.stripe.param.SubscriptionScheduleCreateParams.Phase

Enclosing class:

SubscriptionScheduleCreateParams
```
public static class SubscriptionScheduleCreateParams.Phase
extends java.lang.Object
```
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.InvoiceSettings.extraParams for the field documentation.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`SubscriptionScheduleCreateParams.Phase.BillingThresholds`
`static class`	`SubscriptionScheduleCreateParams.Phase.Builder`
`static class`	`SubscriptionScheduleCreateParams.Phase.CollectionMethod` Usage threshold that triggers the subscription to advance to a new billing period.
`static class`	`SubscriptionScheduleCreateParams.Phase.InvoiceSettings` Indicates if the `billing_cycle_anchor` should be reset when a threshold is reached.
`static class`	`SubscriptionScheduleCreateParams.Phase.Plan` Add all map key/value pairs to `extraParams` map.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static SubscriptionScheduleCreateParams.Phase.Builder`	`builder()`
`java.math.BigDecimal`	`getApplicationFeePercent()` A non-negative decimal between 0 and 100, with at most two decimal places.
`java.lang.Object`	`getBillingThresholds()` Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period.
`SubscriptionScheduleCreateParams.Phase.CollectionMethod`	`getCollectionMethod()` Either `charge_automatically`, or `send_invoice`.
`java.lang.String`	`getCoupon()` The identifier of the coupon to apply to this phase of the subscription schedule.
`java.lang.String`	`getDefaultPaymentMethod()` ID of the default payment method for the subscription schedule.
`java.lang.Object`	`getDefaultTaxRates()` The tax rates that will apply to any phase that does not have `tax_rates` set.
`java.lang.Long`	`getEndDate()` The date at which this phase of the subscription schedule ends.
`java.util.Map<java.lang.String,java.lang.Object>`	`getExtraParams()` Map of extra parameters for custom features not available in this client library.
`SubscriptionScheduleCreateParams.Phase.InvoiceSettings`	`getInvoiceSettings()` All invoices will be billed using the specified settings.
`java.lang.Long`	`getIterations()` Integer representing the multiplier applied to the plan interval.
`java.util.List<SubscriptionScheduleCreateParams.Phase.Plan>`	`getPlans()` List of configuration items, each with an attached plan, to apply during this phase of the subscription schedule.
`java.math.BigDecimal`	`getTaxPercent()` A non-negative decimal (with at most four decimal places) between 0 and 100.
`java.lang.Boolean`	`getTrial()` If set to true the entire phase is counted as a trial and the customer will not be charged for any fees.
`java.lang.Long`	`getTrialEnd()` 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

- Method Detail
  - builder
```
public static SubscriptionScheduleCreateParams.Phase.Builder builder()
```
  - getApplicationFeePercent
```
public java.math.BigDecimal getApplicationFeePercent()
```
    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](https://stripe.com/docs/connect/subscriptions#collecting-fees-on-subscriptions).
  - getBillingThresholds
```
public java.lang.Object getBillingThresholds()
```
    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.
  - getCollectionMethod
```
public SubscriptionScheduleCreateParams.Phase.CollectionMethod getCollectionMethod()
```
    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.
  - getCoupon
```
public java.lang.String getCoupon()
```
    The identifier of the coupon to apply to this phase of the subscription schedule.
  - getDefaultPaymentMethod
```
public java.lang.String getDefaultPaymentMethod()
```
    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.
  - getDefaultTaxRates
```
public java.lang.Object getDefaultTaxRates()
```
    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.
  - getEndDate
```
public java.lang.Long getEndDate()
```
    The date at which this phase of the subscription schedule ends. If set, `iterations` must not be set.
  - getExtraParams
```
public java.util.Map<java.lang.String,java.lang.Object> getExtraParams()
```
    Map of extra parameters for custom features not available in this client library. The content in this map is not serialized under this field's @SerializedName value. Instead, each key/value pair is serialized as if the key is a root-level field (serialized) name in this param object. Effectively, this map is flattened to its parent instance.
  - getInvoiceSettings
```
public SubscriptionScheduleCreateParams.Phase.InvoiceSettings getInvoiceSettings()
```
    All invoices will be billed using the specified settings.
  - getIterations
```
public java.lang.Long getIterations()
```
    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.
  - getPlans
```
public java.util.List<SubscriptionScheduleCreateParams.Phase.Plan> getPlans()
```
    List of configuration items, each with an attached plan, to apply during this phase of the subscription schedule.
  - getTaxPercent
```
public java.math.BigDecimal getTaxPercent()
```
    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`.
  - getTrial
```
public java.lang.Boolean getTrial()
```
    If set to true the entire phase is counted as a trial and the customer will not be charged for any fees.
  - getTrialEnd
```
public java.lang.Long getTrialEnd()
```
    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

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Method Detail

builder

getApplicationFeePercent

getBillingThresholds

getCollectionMethod

getCoupon

getDefaultPaymentMethod

getDefaultTaxRates

getEndDate

getExtraParams

getInvoiceSettings

getIterations

getPlans

getTaxPercent

getTrial

getTrialEnd