Package com.stripe.param

Class SubscriptionResumeParams.Builder

java.lang.Object
com.stripe.param.SubscriptionResumeParams.Builder
Enclosing class:
SubscriptionResumeParams
public static class SubscriptionResumeParams.Builder extends Object

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • build

      public SubscriptionResumeParams build()
      Finalize and obtain parameter instance from this builder.

    • setBillingCycleAnchor

      public SubscriptionResumeParams.Builder setBillingCycleAnchor(SubscriptionResumeParams.BillingCycleAnchor billingCycleAnchor)
      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.

    • addExpand

      public SubscriptionResumeParams.Builder addExpand(String element)
      Add an element to `expand` list. A list is initialized for the first `add/addAll` call, and subsequent calls adds additional elements to the original list. See SubscriptionResumeParams.expand for the field documentation.

    • addAllExpand

      public SubscriptionResumeParams.Builder addAllExpand(List<String> elements)
      Add all elements to `expand` list. A list is initialized for the first `add/addAll` call, and subsequent calls adds additional elements to the original list. See SubscriptionResumeParams.expand for the field documentation.

    • putExtraParam

      public SubscriptionResumeParams.Builder putExtraParam(String key, Object value)
      Add a key/value pair to `extraParams` map. A map is initialized for the first `put/putAll` call, and subsequent calls add additional key/value pairs to the original map. See SubscriptionResumeParams.extraParams for the field documentation.

    • putAllExtraParam

      public SubscriptionResumeParams.Builder putAllExtraParam(Map<String,Object> map)
      Add all map key/value pairs to `extraParams` map. A map is initialized for the first `put/putAll` call, and subsequent calls add additional key/value pairs to the original map. See SubscriptionResumeParams.extraParams for the field documentation.

    • setProrationBehavior

      public SubscriptionResumeParams.Builder setProrationBehavior(SubscriptionResumeParams.ProrationBehavior prorationBehavior)
      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.

    • setProrationDate

      public SubscriptionResumeParams.Builder setProrationDate(Long prorationDate)
      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.