Package com.stripe.param

Class SubscriptionItemDeleteParams.Builder

java.lang.Object

com.stripe.param.SubscriptionItemDeleteParams.Builder

Enclosing class:

SubscriptionItemDeleteParams

public static class SubscriptionItemDeleteParams.Builder
extends Object

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
SubscriptionItemDeleteParams	build()	Finalize and obtain parameter instance from this builder.
SubscriptionItemDeleteParams.Builder	putAllExtraParam(Map<String,Object> map)	Add all map key/value pairs to `extraParams` map.
SubscriptionItemDeleteParams.Builder	putExtraParam(String key, Object value)	Add a key/value pair to `extraParams` map.
SubscriptionItemDeleteParams.Builder	setClearUsage(Boolean clearUsage)	Delete all usage for the given subscription item.
SubscriptionItemDeleteParams.Builder	setPaymentBehavior(SubscriptionItemDeleteParams.PaymentBehavior paymentBehavior)	Controls how Stripe handles payment when a subscription update requires payment and collection_method=charge_automatically.
SubscriptionItemDeleteParams.Builder	setProrationBehavior(SubscriptionItemDeleteParams.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.
SubscriptionItemDeleteParams.Builder	setProrationDate(Long prorationDate)	If set, the proration will be calculated as though the subscription was updated at the given time.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Builder

public Builder()

Method Details

build

public SubscriptionItemDeleteParams build()

Finalize and obtain parameter instance from this builder.

setClearUsage

public SubscriptionItemDeleteParams.Builder setClearUsage(Boolean clearUsage)

Delete all usage for the given subscription item. Allowed only when the current plan's usage_type is metered.

putExtraParam

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

putAllExtraParam

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

setPaymentBehavior

public SubscriptionItemDeleteParams.Builder setPaymentBehavior(SubscriptionItemDeleteParams.PaymentBehavior paymentBehavior)

Controls how Stripe handles payment when a subscription update requires payment and collection_method=charge_automatically.

setProrationBehavior

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

If set, the proration will be calculated as though the subscription was updated at the given time. This can be used to apply the same proration that was previewed with the upcoming invoice endpoint.