Class SubscriptionItemDeleteParams

java.lang.Object
com.stripe.net.ApiRequestParams
com.stripe.param.SubscriptionItemDeleteParams

public class SubscriptionItemDeleteParams extends ApiRequestParams
  • Method Details

    • builder

      public static SubscriptionItemDeleteParams.Builder builder()
    • getClearUsage

      public Boolean getClearUsage()
      Delete all usage for the given subscription item. Allowed only when the current plan's usage_type is metered.
    • 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.
    • getProrationBehavior

      public SubscriptionItemDeleteParams.ProrationBehavior getProrationBehavior()
      Determines how to handle prorations when the billing cycle changes (e.g., when switching plans, resetting billing_cycle_anchor=now, or starting a trial), or if an item's quantity changes. 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.

    • getProrationDate

      public Long getProrationDate()
      If set, the proration will be calculated as though the subscription was updated at the given time. This can be used to apply the same proration that was previewed with the upcoming invoice endpoint.