Package com.stripe.param

Class SubscriptionScheduleCancelParams

java.lang.Object

com.stripe.net.ApiRequestParams

com.stripe.param.SubscriptionScheduleCancelParams

public class SubscriptionScheduleCancelParams
extends ApiRequestParams

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SubscriptionScheduleCancelParams.Builder

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 SubscriptionScheduleCancelParams.Builder	builder()
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.
Boolean	getInvoiceNow()	If the subscription schedule is active, indicates if a final invoice will be generated that contains any un-invoiced metered usage and new/pending proration invoice items.
Boolean	getProrate()	If the subscription schedule is active, indicates if the cancellation should be prorated.

Methods inherited from class com.stripe.net.ApiRequestParams

paramsToMap, toMap

Methods inherited from class java.lang.Object

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

Method Details

builder

public static SubscriptionScheduleCancelParams.Builder builder()

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.

getInvoiceNow

public Boolean getInvoiceNow()

If the subscription schedule is active, indicates if a final invoice will be generated that contains any un-invoiced metered usage and new/pending proration invoice items. Defaults to true.

getProrate

public Boolean getProrate()

If the subscription schedule is active, indicates if the cancellation should be prorated. Defaults to true.