Package com.stripe.param

Class QuoteUpdateParams.SubscriptionDataOverride

java.lang.Object
com.stripe.param.QuoteUpdateParams.SubscriptionDataOverride
Enclosing class:
QuoteUpdateParams
public static class QuoteUpdateParams.SubscriptionDataOverride extends Object

  • Method Details

    • builder

      public static QuoteUpdateParams.SubscriptionDataOverride.Builder builder()

    • getAppliesTo

      public QuoteUpdateParams.SubscriptionDataOverride.AppliesTo getAppliesTo()
      Required. Whether the override applies to an existing Subscription Schedule or a new Subscription Schedule.

    • getBillOnAcceptance

      public Object getBillOnAcceptance()
      Describes the period to bill for upon accepting the quote.

    • getBillingBehavior

      public QuoteUpdateParams.SubscriptionDataOverride.BillingBehavior getBillingBehavior()
      Configures when the subscription schedule generates prorations for phase transitions. Possible values are prorate_on_next_phase or prorate_up_front with the default being prorate_on_next_phase. prorate_on_next_phase will apply phase changes and generate prorations at transition time. prorate_up_front will bill for all phases within the current billing cycle up front.

    • getBillingSchedules

      public Object getBillingSchedules()
      Billing schedules that will be applied to the subscription or subscription schedule created when the quote is accepted.

    • getCustomer

      public Object getCustomer()
      The customer the Subscription Data override applies to.

    • getDescription

      public Object getDescription()
      The subscription's description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription for rendering in Stripe surfaces and certain local payment methods UIs.

    • getEndBehavior

      public QuoteUpdateParams.SubscriptionDataOverride.EndBehavior getEndBehavior()
      Behavior of the subscription schedule and underlying subscription when it ends.

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

    • getPhaseEffectiveAt

      public QuoteUpdateParams.SubscriptionDataOverride.PhaseEffectiveAt getPhaseEffectiveAt()
      Configures how the subscription schedule handles billing for phase transitions when the quote is accepted. 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.

    • getProrationBehavior

      public QuoteUpdateParams.SubscriptionDataOverride.ProrationBehavior getProrationBehavior()
      Determines how to handle prorations. When creating a subscription, valid values are create_prorations or none.

      When updating a subscription, valid values are create_prorations, none, or always_invoice.

      Passing create_prorations will cause proration invoice items to be created when applicable. These proration items will only be invoiced immediately under certain conditions. In order to always invoice immediately for prorations, pass always_invoice.

      Prorations can be disabled by passing none.

    • 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