Package com.stripe.model

Class Quote.SubscriptionDataOverride

java.lang.Object
com.stripe.model.StripeObject
com.stripe.model.Quote.SubscriptionDataOverride
All Implemented Interfaces:
StripeObjectInterface
Enclosing class:
Quote
public static class Quote.SubscriptionDataOverride extends StripeObject
For more details about SubscriptionDataOverride, please refer to the API Reference.

  • Constructor Details

    • SubscriptionDataOverride

      public SubscriptionDataOverride()

  • Method Details

    • getAppliesTo

      public Quote.SubscriptionDataOverride.AppliesTo getAppliesTo()

    • getBillOnAcceptance

      public Quote.SubscriptionDataOverride.BillOnAcceptance getBillOnAcceptance()
      Describes the period to bill for upon accepting the quote.

    • getBillingBehavior

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

      One of prorate_on_next_phase, or prorate_up_front.

    • getBillingSchedules

      public List<Quote.SubscriptionDataOverride.BillingSchedule> getBillingSchedules()
      Billing schedules that will be applied to the subscription or subscription schedule created from this quote.

    • getCustomer

      public String getCustomer()
      The customer which this quote belongs to. A customer is required before finalizing the quote. Once specified, it cannot be changed.

    • getDescription

      public String 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 String getEndBehavior()
      Behavior of the subscription schedule and underlying subscription when it ends.

      One of cancel, or release.

    • getPhaseEffectiveAt

      public String getPhaseEffectiveAt()
      Configures how the quote handles billing for line transitions. Possible values are line_start (default) or billing_period_start. line_start bills based on the current state of the line, ignoring changes scheduled for future lines. billing_period_start bills predictively for upcoming line transitions within the current billing cycle, including pricing changes and service period adjustments that will occur before the next invoice.

      One of billing_period_start, or line_start.

    • getProrationBehavior

      public String getProrationBehavior()
      Determines how to handle prorations when the quote is accepted.

      One of always_invoice, create_prorations, or none.

    • setAppliesTo

      public void setAppliesTo(Quote.SubscriptionDataOverride.AppliesTo appliesTo)

    • setBillOnAcceptance

      public void setBillOnAcceptance(Quote.SubscriptionDataOverride.BillOnAcceptance billOnAcceptance)
      Describes the period to bill for upon accepting the quote.

    • setBillingBehavior

      public void setBillingBehavior(String billingBehavior)
      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.

      One of prorate_on_next_phase, or prorate_up_front.

    • setBillingSchedules

      public void setBillingSchedules(List<Quote.SubscriptionDataOverride.BillingSchedule> billingSchedules)
      Billing schedules that will be applied to the subscription or subscription schedule created from this quote.

    • setCustomer

      public void setCustomer(String customer)
      The customer which this quote belongs to. A customer is required before finalizing the quote. Once specified, it cannot be changed.

    • setDescription

      public void setDescription(String description)
      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.

    • setEndBehavior

      public void setEndBehavior(String endBehavior)
      Behavior of the subscription schedule and underlying subscription when it ends.

      One of cancel, or release.

    • setPhaseEffectiveAt

      public void setPhaseEffectiveAt(String phaseEffectiveAt)
      Configures how the quote handles billing for line transitions. Possible values are line_start (default) or billing_period_start. line_start bills based on the current state of the line, ignoring changes scheduled for future lines. billing_period_start bills predictively for upcoming line transitions within the current billing cycle, including pricing changes and service period adjustments that will occur before the next invoice.

      One of billing_period_start, or line_start.

    • setProrationBehavior

      public void setProrationBehavior(String prorationBehavior)
      Determines how to handle prorations when the quote is accepted.

      One of always_invoice, create_prorations, or 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