Package com.stripe.param

Class QuoteUpdateParams.SubscriptionData

java.lang.Object
com.stripe.param.QuoteUpdateParams.SubscriptionData
Enclosing class:
QuoteUpdateParams
public static class QuoteUpdateParams.SubscriptionData extends Object
The number of intervals between subscription billings. For example, interval=month and interval_count=3 bills every 3 months. Maximum of three years interval allowed (3 years, 36 months, or 156 weeks).

  • Method Details

    • builder

      public static QuoteUpdateParams.SubscriptionData.Builder builder()

    • getBillOnAcceptance

      public Object getBillOnAcceptance()
      Describes the period to bill for upon accepting the quote.

    • getBillingBehavior

      public QuoteUpdateParams.SubscriptionData.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.

    • getBillingCycleAnchor

      public ApiRequestParams.EnumParam getBillingCycleAnchor()
      When specified as reset, the subscription will always start a new billing period when the quote is accepted.

    • getDescription

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

    • getEffectiveDate

      public Object getEffectiveDate()
      When creating a new subscription, the date of which the subscription schedule will start after the quote is accepted. When updating a subscription, the date of which the subscription will be updated using a subscription schedule. The special value current_period_end can be provided to update a subscription at the end of its current period. The effective_date is ignored if it is in the past when the quote is accepted.

    • getEndBehavior

      public QuoteUpdateParams.SubscriptionData.EndBehavior getEndBehavior()
      Behavior of the subscription schedule and underlying subscription when it ends.

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

    • getMetadata

      public Map<String,String> getMetadata()
      Set of key-value pairs that will set metadata on the subscription or subscription schedule when the quote is accepted. If a recurring price is included in line_items, this field will be passed to the resulting subscription's metadata field. If subscription_data.effective_date is used, this field will be passed to the resulting subscription schedule's phases.metadata field. Unlike object-level metadata, this field is declarative. Updates will clear prior values.

    • getPrebilling

      public Object getPrebilling()
      If specified, the invoicing for the given billing cycle iterations will be processed when the quote is accepted. Cannot be used with effective_date.

    • getProrationBehavior

      public QuoteUpdateParams.SubscriptionData.ProrationBehavior getProrationBehavior()
      Determines how to handle prorations. When creating a subscription, valid values are create_prorations or none.

      When updating a subscription, valid values are create_prorations, none, or always_invoice.

      Passing create_prorations will cause proration invoice items to be created when applicable. These proration items will only be invoiced immediately under certain conditions. In order to always invoice immediately for prorations, pass always_invoice.

      Prorations can be disabled by passing none.

    • getTrialPeriodDays

      public Object getTrialPeriodDays()
      Integer representing the number of trial period days before the customer is charged for the first time.

    • 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