Package com.stripe.model

Class QuotePreviewSubscriptionSchedule

java.lang.Object
com.stripe.model.StripeObject
com.stripe.net.ApiResource
com.stripe.model.QuotePreviewSubscriptionSchedule
All Implemented Interfaces:
HasId, StripeActiveObject, StripeObjectInterface
public class QuotePreviewSubscriptionSchedule extends ApiResource implements HasId

  • Constructor Details

    • QuotePreviewSubscriptionSchedule

      public QuotePreviewSubscriptionSchedule()

  • Method Details

    • getApplication

      public String getApplication()
      Get ID of expandable application object.

    • setApplication

      public void setApplication(String id)

    • getApplicationObject

      public Application getApplicationObject()
      Get expanded application.

    • setApplicationObject

      public void setApplicationObject(Application expandableObject)

    • getCustomer

      public String getCustomer()
      Get ID of expandable customer object.

    • setCustomer

      public void setCustomer(String id)

    • getCustomerObject

      public Customer getCustomerObject()
      Get expanded customer.

    • setCustomerObject

      public void setCustomerObject(Customer expandableObject)

    • getSubscription

      public String getSubscription()
      Get ID of expandable subscription object.

    • setSubscription

      public void setSubscription(String id)

    • getSubscriptionObject

      public Subscription getSubscriptionObject()
      Get expanded subscription.

    • setSubscriptionObject

      public void setSubscriptionObject(Subscription expandableObject)

    • getTestClock

      public String getTestClock()
      Get ID of expandable testClock object.

    • setTestClock

      public void setTestClock(String id)

    • getTestClockObject

      public TestClock getTestClockObject()
      Get expanded testClock.

    • setTestClockObject

      public void setTestClockObject(TestClock expandableObject)

    • list

      public static QuotePreviewSubscriptionScheduleCollection list(String quote, Map<String,Object> params) throws StripeException
      Preview the schedules that would be generated by accepting the quote.
      Throws:
      StripeException

    • list

      public static QuotePreviewSubscriptionScheduleCollection list(String quote, Map<String,Object> params, RequestOptions options) throws StripeException
      Preview the schedules that would be generated by accepting the quote.
      Throws:
      StripeException

    • list

      public static QuotePreviewSubscriptionScheduleCollection list(String quote, QuotePreviewSubscriptionScheduleListParams params) throws StripeException
      Preview the schedules that would be generated by accepting the quote.
      Throws:
      StripeException

    • list

      public static QuotePreviewSubscriptionScheduleCollection list(String quote, QuotePreviewSubscriptionScheduleListParams params, RequestOptions options) throws StripeException
      Preview the schedules that would be generated by accepting the quote.
      Throws:
      StripeException

    • setResponseGetter

      public void setResponseGetter(StripeResponseGetter responseGetter)
      Description copied from interface: StripeActiveObject
      Method is used by the containing object or StripeResponseGetter implementations to set the StripeResponseGetter instance used to make further requests.
      Specified by:
      setResponseGetter in interface StripeActiveObject
      Overrides:
      setResponseGetter in class ApiResource
      Parameters:
      responseGetter - the StripeResponseGetter instance to use for making further requests.

    • getAppliesTo

      public QuotePreviewSubscriptionSchedule.AppliesTo getAppliesTo()

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

    • getCanceledAt

      public Long getCanceledAt()
      Time at which the subscription schedule was canceled. Measured in seconds since the Unix epoch.

    • getCompletedAt

      public Long getCompletedAt()
      Time at which the subscription schedule was completed. Measured in seconds since the Unix epoch.

    • getCreated

      public Long getCreated()
      Time at which the object was created. Measured in seconds since the Unix epoch.

    • getCurrentPhase

      public QuotePreviewSubscriptionSchedule.CurrentPhase getCurrentPhase()
      Object representing the start and end dates for the current phase of the subscription schedule, if it is active.

    • getDefaultSettings

      public QuotePreviewSubscriptionSchedule.DefaultSettings getDefaultSettings()

    • getEndBehavior

      public String getEndBehavior()
      Behavior of the subscription schedule and underlying subscription when it ends. Possible values are release or cancel with the default being release. release will end the subscription schedule and keep the underlying subscription running. cancel will end the subscription schedule and cancel the underlying subscription.

      One of cancel, none, release, or renew.

    • getLastPriceMigrationError

      public QuotePreviewSubscriptionSchedule.LastPriceMigrationError getLastPriceMigrationError()
      Details of the most recent price migration that failed for the subscription schedule.

    • getLivemode

      public Boolean getLivemode()
      Has the value true if the object exists in live mode or the value false if the object exists in test mode.

    • getMetadata

      public Map<String,String> getMetadata()
      Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.

    • getObject

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

      Equal to quote_preview_subscription_schedule.

    • getPhases

      public List<QuotePreviewSubscriptionSchedule.Phase> getPhases()
      Configuration for the subscription schedule's phases.

    • getPrebilling

      public QuotePreviewSubscriptionSchedule.Prebilling getPrebilling()
      Time period and invoice for a Subscription billed in advance.

    • getReleasedAt

      public Long getReleasedAt()
      Time at which the subscription schedule was released. Measured in seconds since the Unix epoch.

    • getReleasedSubscription

      public String getReleasedSubscription()
      ID of the subscription once managed by the subscription schedule (if it is released).

    • getStatus

      public String getStatus()
      The present status of the subscription schedule. Possible values are not_started, active, completed, released, and canceled. You can read more about the different states in our behavior guide.

      One of active, canceled, completed, not_started, or released.

    • setAppliesTo

      public void setAppliesTo(QuotePreviewSubscriptionSchedule.AppliesTo appliesTo)

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

    • setCanceledAt

      public void setCanceledAt(Long canceledAt)
      Time at which the subscription schedule was canceled. Measured in seconds since the Unix epoch.

    • setCompletedAt

      public void setCompletedAt(Long completedAt)
      Time at which the subscription schedule was completed. Measured in seconds since the Unix epoch.

    • setCreated

      public void setCreated(Long created)
      Time at which the object was created. Measured in seconds since the Unix epoch.

    • setCurrentPhase

      public void setCurrentPhase(QuotePreviewSubscriptionSchedule.CurrentPhase currentPhase)
      Object representing the start and end dates for the current phase of the subscription schedule, if it is active.

    • setDefaultSettings

      public void setDefaultSettings(QuotePreviewSubscriptionSchedule.DefaultSettings defaultSettings)

    • setEndBehavior

      public void setEndBehavior(String endBehavior)
      Behavior of the subscription schedule and underlying subscription when it ends. Possible values are release or cancel with the default being release. release will end the subscription schedule and keep the underlying subscription running. cancel will end the subscription schedule and cancel the underlying subscription.

      One of cancel, none, release, or renew.

    • setId

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

    • setLastPriceMigrationError

      public void setLastPriceMigrationError(QuotePreviewSubscriptionSchedule.LastPriceMigrationError lastPriceMigrationError)
      Details of the most recent price migration that failed for the subscription schedule.

    • setLivemode

      public void setLivemode(Boolean livemode)
      Has the value true if the object exists in live mode or the value false if the object exists in test mode.

    • setMetadata

      public void setMetadata(Map<String,String> metadata)
      Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.

    • setObject

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

      Equal to quote_preview_subscription_schedule.

    • setPhases

      public void setPhases(List<QuotePreviewSubscriptionSchedule.Phase> phases)
      Configuration for the subscription schedule's phases.

    • setPrebilling

      public void setPrebilling(QuotePreviewSubscriptionSchedule.Prebilling prebilling)
      Time period and invoice for a Subscription billed in advance.

    • setReleasedAt

      public void setReleasedAt(Long releasedAt)
      Time at which the subscription schedule was released. Measured in seconds since the Unix epoch.

    • setReleasedSubscription

      public void setReleasedSubscription(String releasedSubscription)
      ID of the subscription once managed by the subscription schedule (if it is released).

    • setStatus

      public void setStatus(String status)
      The present status of the subscription schedule. Possible values are not_started, active, completed, released, and canceled. You can read more about the different states in our behavior guide.

      One of active, canceled, completed, not_started, or released.

    • 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