Package com.stripe.param
Class SubscriptionScheduleUpdateParams.DefaultSettings.Builder
- java.lang.Object
-
- com.stripe.param.SubscriptionScheduleUpdateParams.DefaultSettings.Builder
-
- Enclosing class:
- SubscriptionScheduleUpdateParams.DefaultSettings
public static class SubscriptionScheduleUpdateParams.DefaultSettings.Builder extends java.lang.Object
-
-
Constructor Summary
Constructors Constructor Description Builder()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description SubscriptionScheduleUpdateParams.DefaultSettings
build()
Finalize and obtain parameter instance from this builder.SubscriptionScheduleUpdateParams.DefaultSettings.Builder
putAllExtraParam(java.util.Map<java.lang.String,java.lang.Object> map)
Add all map key/value pairs to `extraParams` map.SubscriptionScheduleUpdateParams.DefaultSettings.Builder
putExtraParam(java.lang.String key, java.lang.Object value)
Add a key/value pair to `extraParams` map.SubscriptionScheduleUpdateParams.DefaultSettings.Builder
setApplicationFeePercent(java.math.BigDecimal applicationFeePercent)
A non-negative decimal between 0 and 100, with at most two decimal places.SubscriptionScheduleUpdateParams.DefaultSettings.Builder
setAutomaticTax(SubscriptionScheduleUpdateParams.DefaultSettings.AutomaticTax automaticTax)
Default settings for automatic tax computation.SubscriptionScheduleUpdateParams.DefaultSettings.Builder
setBillingCycleAnchor(SubscriptionScheduleUpdateParams.DefaultSettings.BillingCycleAnchor billingCycleAnchor)
Can be set tophase_start
to set the anchor to the start of the phase orautomatic
to automatically change it if needed.SubscriptionScheduleUpdateParams.DefaultSettings.Builder
setBillingThresholds(EmptyParam billingThresholds)
Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period.SubscriptionScheduleUpdateParams.DefaultSettings.Builder
setBillingThresholds(SubscriptionScheduleUpdateParams.DefaultSettings.BillingThresholds billingThresholds)
Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period.SubscriptionScheduleUpdateParams.DefaultSettings.Builder
setCollectionMethod(SubscriptionScheduleUpdateParams.DefaultSettings.CollectionMethod collectionMethod)
Eithercharge_automatically
, orsend_invoice
.SubscriptionScheduleUpdateParams.DefaultSettings.Builder
setDefaultPaymentMethod(EmptyParam defaultPaymentMethod)
ID of the default payment method for the subscription schedule.SubscriptionScheduleUpdateParams.DefaultSettings.Builder
setDefaultPaymentMethod(java.lang.String defaultPaymentMethod)
ID of the default payment method for the subscription schedule.SubscriptionScheduleUpdateParams.DefaultSettings.Builder
setInvoiceSettings(SubscriptionScheduleUpdateParams.DefaultSettings.InvoiceSettings invoiceSettings)
All invoices will be billed using the specified settings.SubscriptionScheduleUpdateParams.DefaultSettings.Builder
setTransferData(EmptyParam transferData)
The data with which to automatically create a Transfer for each of the associated subscription's invoices.SubscriptionScheduleUpdateParams.DefaultSettings.Builder
setTransferData(SubscriptionScheduleUpdateParams.DefaultSettings.TransferData transferData)
The data with which to automatically create a Transfer for each of the associated subscription's invoices.
-
-
-
Method Detail
-
build
public SubscriptionScheduleUpdateParams.DefaultSettings build()
Finalize and obtain parameter instance from this builder.
-
setApplicationFeePercent
public SubscriptionScheduleUpdateParams.DefaultSettings.Builder setApplicationFeePercent(java.math.BigDecimal applicationFeePercent)
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.
-
setAutomaticTax
public SubscriptionScheduleUpdateParams.DefaultSettings.Builder setAutomaticTax(SubscriptionScheduleUpdateParams.DefaultSettings.AutomaticTax automaticTax)
Default settings for automatic tax computation.
-
setBillingCycleAnchor
public SubscriptionScheduleUpdateParams.DefaultSettings.Builder setBillingCycleAnchor(SubscriptionScheduleUpdateParams.DefaultSettings.BillingCycleAnchor billingCycleAnchor)
Can be set tophase_start
to set the anchor to the start of the phase orautomatic
to automatically change it if needed. Cannot be set tophase_start
if this phase specifies a trial. For more information, see the billing cycle documentation.
-
setBillingThresholds
public SubscriptionScheduleUpdateParams.DefaultSettings.Builder setBillingThresholds(SubscriptionScheduleUpdateParams.DefaultSettings.BillingThresholds billingThresholds)
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.
-
setBillingThresholds
public SubscriptionScheduleUpdateParams.DefaultSettings.Builder setBillingThresholds(EmptyParam billingThresholds)
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.
-
setCollectionMethod
public SubscriptionScheduleUpdateParams.DefaultSettings.Builder setCollectionMethod(SubscriptionScheduleUpdateParams.DefaultSettings.CollectionMethod collectionMethod)
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_automatically
on creation.
-
setDefaultPaymentMethod
public SubscriptionScheduleUpdateParams.DefaultSettings.Builder setDefaultPaymentMethod(java.lang.String defaultPaymentMethod)
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.
-
setDefaultPaymentMethod
public SubscriptionScheduleUpdateParams.DefaultSettings.Builder setDefaultPaymentMethod(EmptyParam defaultPaymentMethod)
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.
-
putExtraParam
public SubscriptionScheduleUpdateParams.DefaultSettings.Builder putExtraParam(java.lang.String key, java.lang.Object value)
Add a key/value pair to `extraParams` map. A map is initialized for the first `put/putAll` call, and subsequent calls add additional key/value pairs to the original map. SeeSubscriptionScheduleUpdateParams.DefaultSettings.extraParams
for the field documentation.
-
putAllExtraParam
public SubscriptionScheduleUpdateParams.DefaultSettings.Builder putAllExtraParam(java.util.Map<java.lang.String,java.lang.Object> map)
Add all map key/value pairs to `extraParams` map. A map is initialized for the first `put/putAll` call, and subsequent calls add additional key/value pairs to the original map. SeeSubscriptionScheduleUpdateParams.DefaultSettings.extraParams
for the field documentation.
-
setInvoiceSettings
public SubscriptionScheduleUpdateParams.DefaultSettings.Builder setInvoiceSettings(SubscriptionScheduleUpdateParams.DefaultSettings.InvoiceSettings invoiceSettings)
All invoices will be billed using the specified settings.
-
setTransferData
public SubscriptionScheduleUpdateParams.DefaultSettings.Builder setTransferData(SubscriptionScheduleUpdateParams.DefaultSettings.TransferData transferData)
The data with which to automatically create a Transfer for each of the associated subscription's invoices.
-
setTransferData
public SubscriptionScheduleUpdateParams.DefaultSettings.Builder setTransferData(EmptyParam transferData)
The data with which to automatically create a Transfer for each of the associated subscription's invoices.
-
-