Package com.stripe.param

Class SubscriptionResumeParams

java.lang.Object

com.stripe.net.ApiRequestParams

com.stripe.param.SubscriptionResumeParams

public class SubscriptionResumeParams
extends ApiRequestParams

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SubscriptionResumeParams.BillingCycleAnchor
static class	SubscriptionResumeParams.Builder
static enum	SubscriptionResumeParams.PaymentBehavior
static enum	SubscriptionResumeParams.ProrationBehavior

Nested classes/interfaces inherited from class com.stripe.net.ApiRequestParams

ApiRequestParams.EnumParam

Field Summary

Fields inherited from class com.stripe.net.ApiRequestParams

EXTRA_PARAMS_KEY

Method Summary

Modifier and Type	Method	Description
static SubscriptionResumeParams.Builder	builder()
protected boolean	canEqual(Object other)
boolean	equals(Object o)
SubscriptionResumeParams.BillingCycleAnchor	getBillingCycleAnchor()	The billing cycle anchor that applies when the subscription is resumed.
List<String>	getExpand()	Specifies which fields in the response should be expanded.
Map<String,Object>	getExtraParams()	Map of extra parameters for custom features not available in this client library.
SubscriptionResumeParams.PaymentBehavior	getPaymentBehavior()	Controls whether Stripe attempts payment on the resumption invoice in the resume request, and how payment on that invoice affects the subscription's status.
SubscriptionResumeParams.ProrationBehavior	getProrationBehavior()	Determines how to handle prorations resulting from the billing_cycle_anchor being unchanged.
Long	getProrationDate()	If set, prorations will be calculated as though the subscription was resumed at the given time.
int	hashCode()

Methods inherited from class com.stripe.net.ApiRequestParams

paramsToMap, toMap

Methods inherited from class java.lang.Object

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

Method Details

builder

public static SubscriptionResumeParams.Builder builder()

getBillingCycleAnchor

public SubscriptionResumeParams.BillingCycleAnchor getBillingCycleAnchor()

The billing cycle anchor that applies when the subscription is resumed. Either now or unchanged. The default is now. 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.

getPaymentBehavior

public SubscriptionResumeParams.PaymentBehavior getPaymentBehavior()

Controls whether Stripe attempts payment on the resumption invoice in the resume request, and how payment on that invoice affects the subscription's status. The default is resume_on_payment_attempt.

getProrationBehavior

public SubscriptionResumeParams.ProrationBehavior getProrationBehavior()

Determines how to handle prorations resulting from the billing_cycle_anchor being unchanged. When the billing_cycle_anchor is set to now (default value), no prorations are generated. If no value is passed, the default is create_prorations.

getProrationDate

public Long getProrationDate()

If set, prorations will be calculated as though the subscription was resumed at the given time. This can be used to apply exactly the same prorations that were previewed with the create preview endpoint.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

canEqual

protected boolean canEqual(Object other)

hashCode

public int hashCode()

Overrides:

hashCode in class Object