Package com.stripe.param

Class SubscriptionCancelParams

java.lang.Object

com.stripe.net.ApiRequestParams

com.stripe.param.SubscriptionCancelParams

public class SubscriptionCancelParams
extends ApiRequestParams

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SubscriptionCancelParams.Builder
static class	SubscriptionCancelParams.CancellationDetails

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 SubscriptionCancelParams.Builder	builder()
SubscriptionCancelParams.CancellationDetails	getCancellationDetails()	Details about why this subscription was cancelled.
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()	Will generate a final invoice that invoices for any un-invoiced metered usage and new/pending proration invoice items.
Boolean	getProrate()	Will generate a proration invoice item that credits remaining unused time until the subscription period end.

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 SubscriptionCancelParams.Builder builder()

getCancellationDetails

public SubscriptionCancelParams.CancellationDetails getCancellationDetails()

Details about why this subscription was cancelled.

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()

Will generate a final invoice that invoices for any un-invoiced metered usage and new/pending proration invoice items. Defaults to true.

getProrate

public Boolean getProrate()

Will generate a proration invoice item that credits remaining unused time until the subscription period end. Defaults to false.