Package com.stripe.param

Class SubscriptionUpdateParams.PauseCollection

java.lang.Object

com.stripe.param.SubscriptionUpdateParams.PauseCollection

Enclosing class:

SubscriptionUpdateParams

public static class SubscriptionUpdateParams.PauseCollection
extends Object

The number of intervals between subscription billings. For example, interval=month and interval_count=3 bills every 3 months. Maximum of one year interval allowed (1 year, 12 months, or 52 weeks).

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	SubscriptionUpdateParams.PauseCollection.Behavior
static class	SubscriptionUpdateParams.PauseCollection.Builder

Method Summary

Modifier and Type	Method	Description
static SubscriptionUpdateParams.PauseCollection.Builder	builder()
SubscriptionUpdateParams.PauseCollection.Behavior	getBehavior()	Required. The payment collection behavior for this subscription while paused.
Map<String,Object>	getExtraParams()	Map of extra parameters for custom features not available in this client library.
Long	getResumesAt()	The time after which the subscription will resume collecting payments.

Methods inherited from class java.lang.Object

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

Method Details

builder

public static SubscriptionUpdateParams.PauseCollection.Builder builder()

getBehavior

public SubscriptionUpdateParams.PauseCollection.Behavior getBehavior()

Required. The payment collection behavior for this subscription while paused. One of keep_as_draft, mark_uncollectible, or void.

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.

getResumesAt

public Long getResumesAt()

The time after which the subscription will resume collecting payments.