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 classSubscriptionScheduleUpdateParams.DefaultSettings.AutomaticTaxstatic classSubscriptionScheduleUpdateParams.DefaultSettings.BillingCycleAnchorAdd all map key/value pairs to `extraParams` map.static classSubscriptionScheduleUpdateParams.DefaultSettings.BillingThresholdsAdd all map key/value pairs to `extraParams` map.static classSubscriptionScheduleUpdateParams.DefaultSettings.Builderstatic classSubscriptionScheduleUpdateParams.DefaultSettings.CollectionMethodstatic classSubscriptionScheduleUpdateParams.DefaultSettings.InvoiceSettingsIndicates if thebilling_cycle_anchorshould be reset when a threshold is reached.static classSubscriptionScheduleUpdateParams.DefaultSettings.TransferDataAdd all map key/value pairs to `extraParams` map.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static SubscriptionScheduleUpdateParams.DefaultSettings.Builderbuilder()java.math.BigDecimalgetApplicationFeePercent()A non-negative decimal between 0 and 100, with at most two decimal places.SubscriptionScheduleUpdateParams.DefaultSettings.AutomaticTaxgetAutomaticTax()Default settings for automatic tax computation.SubscriptionScheduleUpdateParams.DefaultSettings.BillingCycleAnchorgetBillingCycleAnchor()Can be set tophase_startto set the anchor to the start of the phase orautomaticto automatically change it if needed.java.lang.ObjectgetBillingThresholds()Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period.SubscriptionScheduleUpdateParams.DefaultSettings.CollectionMethodgetCollectionMethod()Eithercharge_automatically, orsend_invoice.java.lang.ObjectgetDefaultPaymentMethod()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.InvoiceSettingsgetInvoiceSettings()All invoices will be billed using the specified settings.java.lang.ObjectgetTransferData()The data with which to automatically create a Transfer for each of the associated subscription's invoices.
-
-
-
Method Detail
-
builder
public static SubscriptionScheduleUpdateParams.DefaultSettings.Builder builder()
-
getApplicationFeePercent
public java.math.BigDecimal getApplicationFeePercent()
A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice subtotal that will be transferred to the application owner's Stripe account. The request must be made by a platform account on a connected account in order to set an application fee percentage. For more information, see the application fees documentation.
-
getAutomaticTax
public SubscriptionScheduleUpdateParams.DefaultSettings.AutomaticTax getAutomaticTax()
Default settings for automatic tax computation.
-
getBillingCycleAnchor
public SubscriptionScheduleUpdateParams.DefaultSettings.BillingCycleAnchor getBillingCycleAnchor()
Can be set tophase_startto set the anchor to the start of the phase orautomaticto automatically change it if needed. Cannot be set tophase_startif 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()
Eithercharge_automatically, orsend_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 tocharge_automaticallyon 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@SerializedNamevalue. 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 associated subscription's invoices.
-
-