Class PriceCreateParams.Recurring

Enclosing class:

public static class PriceCreateParams.Recurring extends Object
A label that represents units of this product. When set, this will be included in customers' receipts, invoices, Checkout, and the customer portal.
  • Method Details

    • builder

      public static PriceCreateParams.Recurring.Builder builder()
    • getAggregateUsage

      public PriceCreateParams.Recurring.AggregateUsage getAggregateUsage()
      Specifies a usage aggregation strategy for prices of usage_type=metered. Defaults to sum.
    • 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.
    • getInterval

      Required. Specifies billing frequency. Either day, week, month or year.
    • getIntervalCount

      public Long getIntervalCount()
      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).
    • getMeter

      public String getMeter()
      The meter tracking the usage of a metered price.
    • getTrialPeriodDays

      public Long getTrialPeriodDays()
      Default number of trial days when subscribing a customer to this price using trial_from_plan=true.
    • getUsageType

      Configures how the quantity per period should be determined. Can be either metered or licensed. licensed automatically bills the quantity set when adding it to a subscription. metered aggregates the total usage based on usage records. Defaults to licensed.