com.stripe.param

Class SubscriptionScheduleUpdateParams

java.lang.Object

com.stripe.net.ApiRequestParams

com.stripe.param.SubscriptionScheduleUpdateParams

public class SubscriptionScheduleUpdateParams
extends ApiRequestParams

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SubscriptionScheduleUpdateParams.BillingThresholds
static class	SubscriptionScheduleUpdateParams.Builder
static class	SubscriptionScheduleUpdateParams.CollectionMethod
static class	SubscriptionScheduleUpdateParams.EndBehavior
static class	SubscriptionScheduleUpdateParams.InvoiceSettings Indicates if the `billing_cycle_anchor` should be reset when a threshold is reached.
static class	SubscriptionScheduleUpdateParams.Phase Add all map key/value pairs to `extraParams` map.
static class	SubscriptionScheduleUpdateParams.RenewalInterval

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 and Description
static SubscriptionScheduleUpdateParams.Builder	builder()
java.lang.Object	getBillingThresholds() Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period.
SubscriptionScheduleUpdateParams.CollectionMethod	getCollectionMethod() Either `charge_automatically`, or `send_invoice`.
java.lang.Object	getDefaultPaymentMethod() ID of the default payment method for the subscription schedule.
java.lang.Object	getDefaultSource() ID of the default payment source for the subscription schedule.
SubscriptionScheduleUpdateParams.EndBehavior	getEndBehavior() Configures how the subscription schedule behaves when it ends.
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.
SubscriptionScheduleUpdateParams.InvoiceSettings	getInvoiceSettings() All invoices will be billed using the specified settings.
java.util.Map<java.lang.String,java.lang.String>	getMetadata() Set of key-value pairs that you can attach to an object.
java.util.List<SubscriptionScheduleUpdateParams.Phase>	getPhases() List representing phases of the subscription schedule.
java.lang.Boolean	getProrate() If the update changes the current phase, indicates if the changes should be prorated.
SubscriptionScheduleUpdateParams.RenewalInterval	getRenewalInterval() This parameter has been deprecated and will be removed in future API versions.

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

getBillingThresholds

public java.lang.Object getBillingThresholds()

Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. Pass an empty string to remove previously-defined thresholds.

getCollectionMethod

public SubscriptionScheduleUpdateParams.CollectionMethod getCollectionMethod()

Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay the underlying subscription at the end of each billing cycle using the default source attached to the customer. When sending an invoice, Stripe will email your customer an invoice with payment instructions. Defaults to `charge_automatically` on creation.

getDefaultPaymentMethod

public java.lang.Object getDefaultPaymentMethod()

ID of the default payment method for the subscription schedule. It must belong to the customer associated with the subscription schedule. If not set, invoices will use the default payment method in the customer's invoice settings.

getDefaultSource

public java.lang.Object getDefaultSource()

ID of the default payment source for the subscription schedule. It must belong to the customer associated with the subscription schedule and be in a chargeable state. If not set, defaults to the customer's default source.

getEndBehavior

public SubscriptionScheduleUpdateParams.EndBehavior getEndBehavior()

Configures how the subscription schedule behaves when it ends. Possible values are `release` or `cancel` with the default being `release`. `release` will end the subscription schedule and keep the underlying subscription running.`cancel` will end the subscription schedule and cancel the underlying subscription.

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.

getInvoiceSettings

public SubscriptionScheduleUpdateParams.InvoiceSettings getInvoiceSettings()

All invoices will be billed using the specified settings.

getMetadata

public java.util.Map<java.lang.String,java.lang.String> getMetadata()

Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.

getPhases

public java.util.List<SubscriptionScheduleUpdateParams.Phase> getPhases()

List representing phases of the subscription schedule. Each phase can be customized to have different durations, plans, and coupons. If there are multiple phases, the `end_date` of one phase will always equal the `start_date` of the next phase. Note that past phases can be omitted.

getProrate

public java.lang.Boolean getProrate()

If the update changes the current phase, indicates if the changes should be prorated. Defaults to `true`.

getRenewalInterval

public SubscriptionScheduleUpdateParams.RenewalInterval getRenewalInterval()

This parameter has been deprecated and will be removed in future API versions. Configuration for renewing the subscription schedule when it ends. Must be set if `renewal_behavior` is `renew`. Otherwise, must not be set.