Package com.stripe.param

Class SubscriptionCancelParams.Builder

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

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • build

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

    • setCancellationDetails

      public SubscriptionCancelParams.Builder setCancellationDetails(SubscriptionCancelParams.CancellationDetails cancellationDetails)
      Details about why this subscription was cancelled.

    • addExpand

      public SubscriptionCancelParams.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 SubscriptionCancelParams.expand for the field documentation.

    • addAllExpand

      public SubscriptionCancelParams.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 SubscriptionCancelParams.expand for the field documentation.

    • putExtraParam

      public SubscriptionCancelParams.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 SubscriptionCancelParams.extraParams for the field documentation.

    • putAllExtraParam

      public SubscriptionCancelParams.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 SubscriptionCancelParams.extraParams for the field documentation.

    • setInvoiceNow

      public SubscriptionCancelParams.Builder setInvoiceNow(Boolean invoiceNow)
      Will generate a final invoice that invoices for any un-invoiced metered usage and new/pending proration invoice items. Defaults to true.

    • setProrate

      public SubscriptionCancelParams.Builder setProrate(Boolean prorate)
      Will generate a proration invoice item that credits remaining unused time until the subscription period end. Defaults to false.