Package com.stripe.param

Class SubscriptionScheduleCreateParams

java.lang.Object
com.stripe.net.ApiRequestParams
com.stripe.param.SubscriptionScheduleCreateParams
public class SubscriptionScheduleCreateParams extends ApiRequestParams

  • Method Details

    • builder

      public static SubscriptionScheduleCreateParams.Builder builder()

    • getBillingBehavior

      public SubscriptionScheduleCreateParams.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 SubscriptionScheduleCreateParams.BillingMode getBillingMode()
      Controls how prorations and invoices for subscriptions are calculated and orchestrated.

    • getCustomer

      public String getCustomer()
      The identifier of the customer to create the subscription schedule for.

    • getCustomerAccount

      public String getCustomerAccount()
      The identifier of the account to create the subscription schedule for.

    • getDefaultSettings

      public SubscriptionScheduleCreateParams.DefaultSettings getDefaultSettings()
      Object representing the subscription schedule's default settings.

    • getEndBehavior

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

    • getExpand

      public List<String> getExpand()
      Specifies which fields in the response should be expanded.

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

    • getFromSubscription

      public String getFromSubscription()
      Migrate an existing subscription to be managed by a subscription schedule. If this parameter is set, a subscription schedule will be created using the subscription's item(s), set to auto-renew using the subscription's interval. When using this parameter, other parameters (such as phase values) cannot be set. To create a subscription schedule with other modifications, we recommend making two separate API calls.

    • getMetadata

      public Object 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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to metadata.

    • getPhases

      public List<SubscriptionScheduleCreateParams.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 SubscriptionScheduleCreateParams.Prebilling getPrebilling()
      If specified, the invoicing for the given billing cycle iterations will be processed now.

    • getStartDate

      public Object getStartDate()
      When the subscription schedule starts. We recommend using now so that it starts the subscription immediately. You can also use a Unix timestamp to backdate the subscription so that it starts on a past date, or set a future date for the subscription to start on.

    • 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