Package com.stripe.param

Class SubscriptionUpdateParams.Item

java.lang.Object
com.stripe.param.SubscriptionUpdateParams.Item
Enclosing class:
SubscriptionUpdateParams
public static class SubscriptionUpdateParams.Item extends Object
Required. The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.

  • Method Details

    • builder

      public static SubscriptionUpdateParams.Item.Builder builder()

    • getBillingThresholds

      public Object getBillingThresholds()
      Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. When updating, pass an empty string to remove previously-defined thresholds.

    • getClearUsage

      public Boolean getClearUsage()
      Delete all usage for a given subscription item. Allowed only when deleted is set to true and the current plan's usage_type is metered.

    • getDeleted

      public Boolean getDeleted()
      A flag that, if set to true, will delete the specified item.

    • getDiscounts

      public Object getDiscounts()
      The coupons to redeem into discounts for the subscription item.

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

    • getId

      public Object getId()
      Subscription item to update.

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

    • getPlan

      public Object getPlan()
      Plan ID for this item, as a string.

    • getPrice

      public Object getPrice()
      The ID of the price object. When changing a subscription item's price, quantity is set to 1 unless a quantity parameter is provided.

    • getPriceData

      public SubscriptionUpdateParams.Item.PriceData getPriceData()
      Data used to generate a new Price object inline.

    • getQuantity

      public Long getQuantity()
      Quantity for this item.

    • getTaxRates

      public Object getTaxRates()
      A list of Tax Rate ids. These Tax Rates will override the default_tax_rates on the Subscription. When updating, pass an empty string to remove previously-defined tax rates.