Package com.stripe.param

Class SubscriptionScheduleCreateParams.DefaultSettings.Builder

java.lang.Object

com.stripe.param.SubscriptionScheduleCreateParams.DefaultSettings.Builder

Enclosing class:

SubscriptionScheduleCreateParams.DefaultSettings

public static class SubscriptionScheduleCreateParams.DefaultSettings.Builder
extends Object

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
SubscriptionScheduleCreateParams.DefaultSettings	build()	Finalize and obtain parameter instance from this builder.
SubscriptionScheduleCreateParams.DefaultSettings.Builder	putAllExtraParam(Map<String,Object> map)	Add all map key/value pairs to `extraParams` map.
SubscriptionScheduleCreateParams.DefaultSettings.Builder	putExtraParam(String key, Object value)	Add a key/value pair to `extraParams` map.
SubscriptionScheduleCreateParams.DefaultSettings.Builder	setApplicationFeePercent(BigDecimal applicationFeePercent)	A non-negative decimal between 0 and 100, with at most two decimal places.
SubscriptionScheduleCreateParams.DefaultSettings.Builder	setAutomaticTax(SubscriptionScheduleCreateParams.DefaultSettings.AutomaticTax automaticTax)	Default settings for automatic tax computation.
SubscriptionScheduleCreateParams.DefaultSettings.Builder	setBillingCycleAnchor(SubscriptionScheduleCreateParams.DefaultSettings.BillingCycleAnchor billingCycleAnchor)	Can be set to phase_start to set the anchor to the start of the phase or automatic to automatically change it if needed.
SubscriptionScheduleCreateParams.DefaultSettings.Builder	setBillingThresholds(EmptyParam billingThresholds)	Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period.
SubscriptionScheduleCreateParams.DefaultSettings.Builder	setBillingThresholds(SubscriptionScheduleCreateParams.DefaultSettings.BillingThresholds billingThresholds)	Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period.
SubscriptionScheduleCreateParams.DefaultSettings.Builder	setCollectionMethod(SubscriptionScheduleCreateParams.DefaultSettings.CollectionMethod collectionMethod)	Either charge_automatically, or send_invoice.
SubscriptionScheduleCreateParams.DefaultSettings.Builder	setDefaultPaymentMethod(String defaultPaymentMethod)	ID of the default payment method for the subscription schedule.
SubscriptionScheduleCreateParams.DefaultSettings.Builder	setDescription(EmptyParam description)	Subscription description, meant to be displayable to the customer.
SubscriptionScheduleCreateParams.DefaultSettings.Builder	setDescription(String description)	Subscription description, meant to be displayable to the customer.
SubscriptionScheduleCreateParams.DefaultSettings.Builder	setInvoiceSettings(SubscriptionScheduleCreateParams.DefaultSettings.InvoiceSettings invoiceSettings)	All invoices will be billed using the specified settings.
SubscriptionScheduleCreateParams.DefaultSettings.Builder	setOnBehalfOf(EmptyParam onBehalfOf)	The account on behalf of which to charge, for each of the associated subscription's invoices.
SubscriptionScheduleCreateParams.DefaultSettings.Builder	setOnBehalfOf(String onBehalfOf)	The account on behalf of which to charge, for each of the associated subscription's invoices.
SubscriptionScheduleCreateParams.DefaultSettings.Builder	setTransferData(EmptyParam transferData)	The data with which to automatically create a Transfer for each of the associated subscription's invoices.
SubscriptionScheduleCreateParams.DefaultSettings.Builder	setTransferData(SubscriptionScheduleCreateParams.DefaultSettings.TransferData transferData)	The data with which to automatically create a Transfer for each of the associated subscription's invoices.

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder()

Method Details

build

public SubscriptionScheduleCreateParams.DefaultSettings build()

Finalize and obtain parameter instance from this builder.

setApplicationFeePercent

public SubscriptionScheduleCreateParams.DefaultSettings.Builder setApplicationFeePercent(BigDecimal applicationFeePercent)

A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total 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 SubscriptionScheduleCreateParams.DefaultSettings.Builder setAutomaticTax(SubscriptionScheduleCreateParams.DefaultSettings.AutomaticTax automaticTax)

Default settings for automatic tax computation.

setBillingCycleAnchor

public SubscriptionScheduleCreateParams.DefaultSettings.Builder setBillingCycleAnchor(SubscriptionScheduleCreateParams.DefaultSettings.BillingCycleAnchor billingCycleAnchor)

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.

setBillingThresholds

public SubscriptionScheduleCreateParams.DefaultSettings.Builder setBillingThresholds(SubscriptionScheduleCreateParams.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 SubscriptionScheduleCreateParams.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 SubscriptionScheduleCreateParams.DefaultSettings.Builder setCollectionMethod(SubscriptionScheduleCreateParams.DefaultSettings.CollectionMethod collectionMethod)

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 and mark the subscription as active. Defaults to charge_automatically on creation.

setDefaultPaymentMethod

public SubscriptionScheduleCreateParams.DefaultSettings.Builder setDefaultPaymentMethod(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.

setDescription

public SubscriptionScheduleCreateParams.DefaultSettings.Builder setDescription(String description)

Subscription description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription for rendering in Stripe surfaces and certain local payment methods UIs.

setDescription

public SubscriptionScheduleCreateParams.DefaultSettings.Builder setDescription(EmptyParam description)

Subscription description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription for rendering in Stripe surfaces and certain local payment methods UIs.

putExtraParam

public SubscriptionScheduleCreateParams.DefaultSettings.Builder putExtraParam(String key,
 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. See SubscriptionScheduleCreateParams.DefaultSettings.extraParams for the field documentation.

putAllExtraParam

public SubscriptionScheduleCreateParams.DefaultSettings.Builder putAllExtraParam(Map<String,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. See SubscriptionScheduleCreateParams.DefaultSettings.extraParams for the field documentation.

setInvoiceSettings

public SubscriptionScheduleCreateParams.DefaultSettings.Builder setInvoiceSettings(SubscriptionScheduleCreateParams.DefaultSettings.InvoiceSettings invoiceSettings)

All invoices will be billed using the specified settings.

setOnBehalfOf

public SubscriptionScheduleCreateParams.DefaultSettings.Builder setOnBehalfOf(String onBehalfOf)

The account on behalf of which to charge, for each of the associated subscription's invoices.

setOnBehalfOf

public SubscriptionScheduleCreateParams.DefaultSettings.Builder setOnBehalfOf(EmptyParam onBehalfOf)

The account on behalf of which to charge, for each of the associated subscription's invoices.

setTransferData

public SubscriptionScheduleCreateParams.DefaultSettings.Builder setTransferData(SubscriptionScheduleCreateParams.DefaultSettings.TransferData transferData)

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

setTransferData

public SubscriptionScheduleCreateParams.DefaultSettings.Builder setTransferData(EmptyParam transferData)

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