Package com.stripe.param

Class QuoteUpdateParams.Phase

java.lang.Object
com.stripe.param.QuoteUpdateParams.Phase
Enclosing class:
QuoteUpdateParams
public static class QuoteUpdateParams.Phase extends Object
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).

  • Method Details

    • builder

      public static QuoteUpdateParams.Phase.Builder builder()

    • getBillingCycleAnchor

      public QuoteUpdateParams.Phase.BillingCycleAnchor getBillingCycleAnchor()
      When specified as reset, the subscription will always start a new billing period when the quote is accepted.

    • getCollectionMethod

      public QuoteUpdateParams.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 and mark the subscription as active. Defaults to charge_automatically on creation.

    • getDefaultTaxRates

      public Object getDefaultTaxRates()
      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.

    • getDiscounts

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

      public Long getEndDate()
      The date at which this phase of the quote ends. If set, iterations must not be set.

    • getExtraParams

      public Map<String,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 QuoteUpdateParams.Phase.InvoiceSettings getInvoiceSettings()
      All invoices will be billed using the specified settings.

    • getIterations

      public Long getIterations()
      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.

    • getLineItems

      public List<QuoteUpdateParams.Phase.LineItem> getLineItems()
      Required. 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

      public QuoteUpdateParams.Phase.ProrationBehavior getProrationBehavior()
      If the update changes the current phase, indicates whether the changes should be prorated. The default value is create_prorations.

    • getTrial

      public 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 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.