Class SubscriptionResumeParams


public class SubscriptionResumeParams extends ApiRequestParams
  • Method Details

    • builder

      public static SubscriptionResumeParams.Builder builder()
    • getBillingCycleAnchor

      public SubscriptionResumeParams.BillingCycleAnchor getBillingCycleAnchor()
      Either now or unchanged. Setting the value to now resets the subscription's billing cycle anchor to the current time (in UTC). Setting the value to unchanged advances the subscription's billing cycle anchor to the period that surrounds the current time. For more information, see the billing cycle documentation.
    • getExpand

      public List<String> getExpand()
      Specifies which fields in the response should be expanded.
    • 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 SubscriptionResumeParams.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. The default value is create_prorations.
    • getProrationDate

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