Package com.stripe.param

Class SubscriptionScheduleUpdateParams.DefaultSettings

java.lang.Object

com.stripe.param.SubscriptionScheduleUpdateParams.DefaultSettings

Enclosing class:

SubscriptionScheduleUpdateParams

public static class SubscriptionScheduleUpdateParams.DefaultSettings
extends java.lang.Object

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static SubscriptionScheduleUpdateParams.DefaultSettings.Builder	builder()
SubscriptionScheduleUpdateParams.DefaultSettings.BillingCycleAnchor	getBillingCycleAnchor()	Can be set to phase_start to set the anchor to the start of the phase or automatic to automatically change it if needed.
java.lang.Object	getBillingThresholds()	Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period.
SubscriptionScheduleUpdateParams.DefaultSettings.CollectionMethod	getCollectionMethod()	Either charge_automatically, or send_invoice.
java.lang.Object	getDefaultPaymentMethod()	ID of the default payment method for the subscription schedule.
java.util.Map<java.lang.String,java.lang.Object>	getExtraParams()	Map of extra parameters for custom features not available in this client library.
SubscriptionScheduleUpdateParams.DefaultSettings.InvoiceSettings	getInvoiceSettings()	All invoices will be billed using the specified settings.
java.lang.Object	getTransferData()	The data with which to automatically create a Transfer for each of the subscription's invoices.

Methods inherited from class java.lang.Object

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

Method Detail

builder

public static SubscriptionScheduleUpdateParams.DefaultSettings.Builder builder()

getBillingCycleAnchor

public SubscriptionScheduleUpdateParams.DefaultSettings.BillingCycleAnchor getBillingCycleAnchor()

Can be set to phase_start to set the anchor to the start of the phase or automatic to automatically change it if needed. Cannot be set to phase_start if this phase specifies a trial. For more information, see the billing cycle documentation.

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.DefaultSettings.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.

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.DefaultSettings.InvoiceSettings getInvoiceSettings()

All invoices will be billed using the specified settings.

getTransferData

public java.lang.Object getTransferData()

The data with which to automatically create a Transfer for each of the subscription's invoices.