Package com.stripe.param

Class InvoiceCreatePreviewParams.ScheduleDetails

java.lang.Object
com.stripe.param.InvoiceCreatePreviewParams.ScheduleDetails
Enclosing class:
InvoiceCreatePreviewParams
public static class InvoiceCreatePreviewParams.ScheduleDetails extends Object

  • Method Details

    • builder

      public static InvoiceCreatePreviewParams.ScheduleDetails.Builder builder()

    • getAmendments

      public List<InvoiceCreatePreviewParams.ScheduleDetails.Amendment> getAmendments()
      Changes to apply to the phases of the subscription schedule, in the order provided.

    • getBillingBehavior

      public InvoiceCreatePreviewParams.ScheduleDetails.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.

    • getBillingMode

      public InvoiceCreatePreviewParams.ScheduleDetails.BillingMode getBillingMode()
      Controls how prorations and invoices for subscriptions are calculated and orchestrated.

    • getEndBehavior

      public InvoiceCreatePreviewParams.ScheduleDetails.EndBehavior 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.

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

    • getPhases

      public List<InvoiceCreatePreviewParams.ScheduleDetails.Phase> getPhases()
      List representing phases of the subscription schedule. Each phase can be customized to have different durations, plans, and coupons. If there are multiple phases, the end_date of one phase will always equal the start_date of the next phase.

    • getPrebilling

      public Object getPrebilling()
      Provide any time periods to bill in advance.

    • getProrationBehavior

      public InvoiceCreatePreviewParams.ScheduleDetails.ProrationBehavior getProrationBehavior()
      In cases where the schedule_details params update the currently active phase, specifies if and how to prorate at the time of the request.

    • 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