Package com.stripe.model

Class QuoteLine

java.lang.Object
com.stripe.model.StripeObject
com.stripe.model.QuoteLine
All Implemented Interfaces:
HasId, StripeObjectInterface
public class QuoteLine extends StripeObject implements HasId
A quote line defines a set of changes, in the order provided, that will be applied upon quote acceptance.

  • Constructor Details

    • QuoteLine

      public QuoteLine()

  • Method Details

    • getActions

      public List<QuoteLine.Action> getActions()
      A list of items the customer is being quoted for.

    • getAppliesTo

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

    • getBillingCycleAnchor

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

      One of automatic, or line_starts_at.

    • getCancelSubscriptionSchedule

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

    • getEndsAt

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

    • getObject

      public String getObject()
      String representing the object's type. Objects of the same type share the same value.

      Equal to quote_line.

    • getProrationBehavior

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

      One of always_invoice, create_prorations, or none.

    • getSetPauseCollection

      public QuoteLine.SetPauseCollection getSetPauseCollection()
      Details to modify the pause_collection behavior of the subscription schedule.

    • getSetScheduleEnd

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

      One of line_ends_at, or line_starts_at.

    • getStartsAt

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

    • getTrialSettings

      public QuoteLine.TrialSettings getTrialSettings()
      Settings related to subscription trials.

    • setActions

      public void setActions(List<QuoteLine.Action> actions)
      A list of items the customer is being quoted for.

    • setAppliesTo

      public void setAppliesTo(QuoteLine.AppliesTo appliesTo)
      Details to identify the subscription schedule the quote line applies to.

    • setBillingCycleAnchor

      public void setBillingCycleAnchor(String billingCycleAnchor)
      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.

      One of automatic, or line_starts_at.

    • setCancelSubscriptionSchedule

      public void setCancelSubscriptionSchedule(QuoteLine.CancelSubscriptionSchedule cancelSubscriptionSchedule)
      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.

    • setEndsAt

      public void setEndsAt(QuoteLine.EndsAt endsAt)
      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.

    • setId

      public void setId(String id)
      Unique identifier for the object.

    • setObject

      public void setObject(String object)
      String representing the object's type. Objects of the same type share the same value.

      Equal to quote_line.

    • setProrationBehavior

      public void setProrationBehavior(String prorationBehavior)
      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.

      One of always_invoice, create_prorations, or none.

    • setSetPauseCollection

      public void setSetPauseCollection(QuoteLine.SetPauseCollection setPauseCollection)
      Details to modify the pause_collection behavior of the subscription schedule.

    • setSetScheduleEnd

      public void setSetScheduleEnd(String setScheduleEnd)
      Timestamp helper to end the underlying schedule early, based on the acompanying line's start or end date.

      One of line_ends_at, or line_starts_at.

    • setStartsAt

      public void setStartsAt(QuoteLine.StartsAt startsAt)
      Details to identify the earliest timestamp where the proposed change should take effect.

    • setTrialSettings

      public void setTrialSettings(QuoteLine.TrialSettings trialSettings)
      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

    • getId

      public String getId()
      Unique identifier for the object.
      Specified by:
      getId in interface HasId