Package com.stripe.param
Class SubscriptionScheduleCreateParams.Phase
- java.lang.Object
-
- com.stripe.param.SubscriptionScheduleCreateParams.Phase
-
- Enclosing class:
- SubscriptionScheduleCreateParams
public static class SubscriptionScheduleCreateParams.Phase extends java.lang.Object
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
SubscriptionScheduleCreateParams.Phase.AddInvoiceItem
static class
SubscriptionScheduleCreateParams.Phase.BillingCycleAnchor
Add all map key/value pairs to `extraParams` map.static class
SubscriptionScheduleCreateParams.Phase.BillingThresholds
Same asunit_amount
, but accepts a decimal value in %s with at most 12 decimal places.static class
SubscriptionScheduleCreateParams.Phase.Builder
static class
SubscriptionScheduleCreateParams.Phase.CollectionMethod
static class
SubscriptionScheduleCreateParams.Phase.InvoiceSettings
Indicates if thebilling_cycle_anchor
should be reset when a threshold is reached.static class
SubscriptionScheduleCreateParams.Phase.Item
Add all map key/value pairs to `extraParams` map.static class
SubscriptionScheduleCreateParams.Phase.ProrationBehavior
static class
SubscriptionScheduleCreateParams.Phase.TransferData
The number of intervals between subscription billings.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static SubscriptionScheduleCreateParams.Phase.Builder
builder()
java.util.List<SubscriptionScheduleCreateParams.Phase.AddInvoiceItem>
getAddInvoiceItems()
A list of prices and quantities that will generate invoice items appended to the next invoice.java.math.BigDecimal
getApplicationFeePercent()
A non-negative decimal between 0 and 100, with at most two decimal places.SubscriptionScheduleCreateParams.Phase.BillingCycleAnchor
getBillingCycleAnchor()
Can be set tophase_start
to set the anchor to the start of the phase orautomatic
to automatically change it if needed.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()
Eithercharge_automatically
, orsend_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()
A list of Tax Rate ids.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.util.List<SubscriptionScheduleCreateParams.Phase.Item>
getItems()
List of configuration items, each with an attached price, to apply during this phase of the subscription schedule.java.lang.Long
getIterations()
Integer representing the multiplier applied to the price interval.SubscriptionScheduleCreateParams.Phase.ProrationBehavior
getProrationBehavior()
If a subscription schedule will create prorations when transitioning to this phase.SubscriptionScheduleCreateParams.Phase.TransferData
getTransferData()
The data with which to automatically create a Transfer for each of the associated subscription's invoices.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.
-
-
-
Method Detail
-
builder
public static SubscriptionScheduleCreateParams.Phase.Builder builder()
-
getAddInvoiceItems
public java.util.List<SubscriptionScheduleCreateParams.Phase.AddInvoiceItem> getAddInvoiceItems()
A list of prices and quantities that will generate invoice items appended to the next invoice. You may pass up to 20 items.
-
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.
-
getBillingCycleAnchor
public SubscriptionScheduleCreateParams.Phase.BillingCycleAnchor getBillingCycleAnchor()
Can be set tophase_start
to set the anchor to the start of the phase orautomatic
to automatically change it if needed. Cannot be set tophase_start
if this phase specifies a trial. For more information, see the billing cycle documentation.
-
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()
Eithercharge_automatically
, orsend_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 tocharge_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()
A list of Tax Rate ids. These Tax Rates will set the Subscription'sdefault_tax_rates
, which means they will be the Invoice'sdefault_tax_rates
for any Invoices issued by the Subscription during this 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.
-
getItems
public java.util.List<SubscriptionScheduleCreateParams.Phase.Item> getItems()
List of configuration items, each with an attached price, to apply during this phase of the subscription schedule.
-
getIterations
public java.lang.Long getIterations()
Integer representing the multiplier applied to the price interval. For example,iterations=2
applied to a price withinterval=month
andinterval_count=3
results in a phase of duration2 * 3 months = 6 months
. If set,end_date
must not be set.
-
getProrationBehavior
public SubscriptionScheduleCreateParams.Phase.ProrationBehavior getProrationBehavior()
If a subscription schedule will create prorations when transitioning to this phase. Possible values arecreate_prorations
ornone
, and the default value iscreate_prorations
. See Prorations.
-
getTransferData
public SubscriptionScheduleCreateParams.Phase.TransferData getTransferData()
The data with which to automatically create a Transfer for each of the associated subscription's invoices.
-
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 withtrial
-
-