Package com.stripe.param

Class QuoteUpdateParams.Line

java.lang.Object
com.stripe.param.QuoteUpdateParams.Line
Enclosing class:
QuoteUpdateParams
public static class QuoteUpdateParams.Line extends Object
Required. Type of the account referenced in the request.

  • Method Details

    • builder

      public static QuoteUpdateParams.Line.Builder builder()

    • getActions

      public List<QuoteUpdateParams.Line.Action> getActions()
      An array of operations the quote line performs.

    • getAppliesTo

      public QuoteUpdateParams.Line.AppliesTo getAppliesTo()
      Details to identify the subscription schedule the quote line applies to.

    • getBillingCycleAnchor

      public QuoteUpdateParams.Line.BillingCycleAnchor getBillingCycleAnchor()
      For point-in-time quote lines (having no ends_at timestamp), this attribute lets you set or remove whether the subscription's billing cycle anchor is reset at the Quote Line starts_at timestamp.For time-span based quote lines (having both starts_at and ends_at), the only valid value is automatic, which removes any previously configured billing cycle anchor resets during the window of time spanning the quote line.

    • getCancelSubscriptionSchedule

      public QuoteUpdateParams.Line.CancelSubscriptionSchedule getCancelSubscriptionSchedule()
      A point-in-time operation that cancels an existing subscription schedule at the line's starts_at timestamp. Currently only compatible with quote_acceptance_date for starts_at. When using cancel_subscription_schedule, the subscription schedule on the quote remains unalterable, except for modifications to the metadata, collection_method or invoice_settings.

    • getEffectiveAt

      public QuoteUpdateParams.Line.EffectiveAt getEffectiveAt()
      Configures how the subscription schedule handles billing for phase transitions. Possible values are phase_start (default) or billing_period_start. phase_start bills based on the current state of the subscription, ignoring changes scheduled in future phases. billing_period_start bills predictively for upcoming phase transitions within the current billing cycle, including pricing changes and service period adjustments that will occur before the next invoice.

    • getEndsAt

      public QuoteUpdateParams.Line.EndsAt getEndsAt()
      Details to identify the end of the time range modified by the proposed change. If not supplied, the quote line is considered a point-in-time operation that only affects the exact timestamp at starts_at, and a restricted set of attributes is supported on the quote line.

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

    • getId

      public Object getId()
      The ID of an existing line on the quote.

    • getProrationBehavior

      public QuoteUpdateParams.Line.ProrationBehavior getProrationBehavior()
      Changes to how Stripe handles prorations during the quote line's time span. Affects if and how prorations are created when a future phase starts.

    • getSetPauseCollection

      public QuoteUpdateParams.Line.SetPauseCollection getSetPauseCollection()
      Defines how to pause collection for the underlying subscription throughout the duration of the amendment.

    • getSetScheduleEnd

      public QuoteUpdateParams.Line.SetScheduleEnd getSetScheduleEnd()
      Timestamp helper to end the underlying schedule early, based on the acompanying line's start or end date.

    • getStartsAt

      public QuoteUpdateParams.Line.StartsAt getStartsAt()
      Details to identify the earliest timestamp where the proposed change should take effect.

    • getTrialSettings

      public QuoteUpdateParams.Line.TrialSettings getTrialSettings()
      Settings related to subscription trials.

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object

    • canEqual

      protected boolean canEqual(Object other)

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object