Package com.stripe.param
Class QuoteCreateParams.Phase
java.lang.Object
com.stripe.param.QuoteCreateParams.Phase
- Enclosing class:
- QuoteCreateParams
The number of intervals between subscription billings. For example,
interval=month
and interval_count=3
bills every 3 months. Maximum of one year
interval allowed (1 year, 12 months, or 52 weeks).-
Nested Class Summary
Modifier and TypeClassDescriptionstatic enum
The number of intervals between subscription billings.static class
static enum
static class
static class
The number of intervals, as an whole number greater than 0.static class
Add all map key/value pairs to `extraParams` map.static enum
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
When specified asreset
, the subscription will always start a new billing period when the quote is accepted.Eithercharge_automatically
, orsend_invoice
.A list of Tax Rate ids.The coupons to redeem into discounts for the schedule phase.The date at which this phase of the quote ends.Map of extra parameters for custom features not available in this client library.All invoices will be billed using the specified settings.Integer representing the multiplier applied to the price interval.A list of line items the customer is being quoted for within this phase.If the update changes the current phase, indicates whether the changes should be prorated.getTrial()
If set to true the entire phase is counted as a trial and the customer will not be charged for any fees.Sets the phase to trialing from the start date to this date.
-
Method Details
-
builder
-
getBillingCycleAnchor
When specified asreset
, the subscription will always start a new billing period when the quote is accepted. -
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 and mark the subscription asactive
. Defaults tocharge_automatically
on creation. -
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. -
getDiscounts
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. -
getEndDate
The date at which this phase of the quote ends. If set,iterations
must not be set. -
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
All invoices will be billed using the specified settings. -
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. -
getLineItems
A list of line items the customer is being quoted for within this phase. Each line item includes information about the product, the quantity, and the resulting cost. -
getProrationBehavior
If the update changes the current phase, indicates whether the changes should be prorated. The default value iscreate_prorations
. -
getTrial
If set to true the entire phase is counted as a trial and the customer will not be charged for any fees. -
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
.
-