Class SubscriptionUpdateParams.Item

  • Enclosing class:

    public static class SubscriptionUpdateParams.Item
    extends java.lang.Object
    Indicates if the billing_cycle_anchor should be reset when a threshold is reached. If true, billing_cycle_anchor will be updated to the date/time the threshold was last reached; otherwise, the value will remain unchanged.
    • Method Detail

      • getBillingThresholds

        public java.lang.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 java.lang.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 java.lang.Boolean getDeleted()
        A flag that, if set to true, will delete the specified item.
      • getExtraParams

        public java.util.Map<java.lang.String,​java.lang.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 java.lang.Object getId()
        Subscription item to update.
      • getMetadata

        public java.lang.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 java.lang.Object getPlan()
        Plan ID for this item, as a string.
      • getPrice

        public java.lang.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.
      • getQuantity

        public java.lang.Long getQuantity()
        Quantity for this item.
      • getTaxRates

        public java.lang.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.