SubscriptionScheduleCancelParams (stripe-java 20.93.0 API)

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

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static SubscriptionScheduleCancelParams.Builder`	`builder()`
`java.util.List<java.lang.String>`	`getExpand()`	Specifies which fields in the response should be expanded.
`java.util.Map<java.lang.String,java.lang.Object>`	`getExtraParams()`	Map of extra parameters for custom features not available in this client library.
`java.lang.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.
`java.lang.Boolean`	`getProrate()`	If the subscription schedule is `active`, indicates if the cancellation should be prorated.

Methods inherited from class com.stripe.net.ApiRequestParams
toMap

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - builder
```
public static SubscriptionScheduleCancelParams.Builder builder()
```
  - getExpand
```
public java.util.List<java.lang.String> getExpand()
```
    Specifies which fields in the response should be expanded.
  - getExtraParams
```
public java.util.Map<java.lang.String,java.lang.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 java.lang.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 java.lang.Boolean getProrate()
```
    If the subscription schedule is active, indicates if the cancellation should be prorated. Defaults to true.