com.stripe.param

Class SubscriptionCreateParams.Builder

java.lang.Object

com.stripe.param.SubscriptionCreateParams.Builder

Enclosing class:

SubscriptionCreateParams

public static class SubscriptionCreateParams.Builder
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
SubscriptionCreateParams.Builder	addAddInvoiceItem(SubscriptionCreateParams.AddInvoiceItem element) Add an element to `addInvoiceItems` list.
SubscriptionCreateParams.Builder	addAllAddInvoiceItem(java.util.List<SubscriptionCreateParams.AddInvoiceItem> elements) Add all elements to `addInvoiceItems` list.
SubscriptionCreateParams.Builder	addAllDefaultTaxRate(java.util.List<java.lang.String> elements) Add all elements to `defaultTaxRates` list.
SubscriptionCreateParams.Builder	addAllExpand(java.util.List<java.lang.String> elements) Add all elements to `expand` list.
SubscriptionCreateParams.Builder	addAllItem(java.util.List<SubscriptionCreateParams.Item> elements) Add all elements to `items` list.
SubscriptionCreateParams.Builder	addDefaultTaxRate(java.lang.String element) Add an element to `defaultTaxRates` list.
SubscriptionCreateParams.Builder	addExpand(java.lang.String element) Add an element to `expand` list.
SubscriptionCreateParams.Builder	addItem(SubscriptionCreateParams.Item element) Add an element to `items` list.
SubscriptionCreateParams	build() Finalize and obtain parameter instance from this builder.
SubscriptionCreateParams.Builder	putAllExtraParam(java.util.Map<java.lang.String,java.lang.Object> map) Add all map key/value pairs to `extraParams` map.
SubscriptionCreateParams.Builder	putAllMetadata(java.util.Map<java.lang.String,java.lang.String> map) Add all map key/value pairs to `metadata` map.
SubscriptionCreateParams.Builder	putExtraParam(java.lang.String key, java.lang.Object value) Add a key/value pair to `extraParams` map.
SubscriptionCreateParams.Builder	putMetadata(java.lang.String key, java.lang.String value) Add a key/value pair to `metadata` map.
SubscriptionCreateParams.Builder	setApplicationFeePercent(java.math.BigDecimal applicationFeePercent) A non-negative decimal between 0 and 100, with at most two decimal places.
SubscriptionCreateParams.Builder	setBackdateStartDate(java.lang.Long backdateStartDate) For new subscriptions, a past timestamp to backdate the subscription's start date to.
SubscriptionCreateParams.Builder	setBillingCycleAnchor(java.lang.Long billingCycleAnchor) A future timestamp to anchor the subscription's billing cycle.
SubscriptionCreateParams.Builder	setBillingThresholds(EmptyParam billingThresholds) Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period.
SubscriptionCreateParams.Builder	setBillingThresholds(SubscriptionCreateParams.BillingThresholds billingThresholds) Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period.
SubscriptionCreateParams.Builder	setCancelAt(java.lang.Long cancelAt) A timestamp at which the subscription should cancel.
SubscriptionCreateParams.Builder	setCancelAtPeriodEnd(java.lang.Boolean cancelAtPeriodEnd) Boolean indicating whether this subscription should cancel at the end of the current period.
SubscriptionCreateParams.Builder	setCollectionMethod(SubscriptionCreateParams.CollectionMethod collectionMethod) Either charge_automatically, or send_invoice.
SubscriptionCreateParams.Builder	setCoupon(java.lang.String coupon) The code of the coupon to apply to this subscription.
SubscriptionCreateParams.Builder	setCustomer(java.lang.String customer) The identifier of the customer to subscribe.
SubscriptionCreateParams.Builder	setDaysUntilDue(java.lang.Long daysUntilDue) Number of days a customer has to pay invoices generated by this subscription.
SubscriptionCreateParams.Builder	setDefaultPaymentMethod(java.lang.String defaultPaymentMethod) ID of the default payment method for the subscription.
SubscriptionCreateParams.Builder	setDefaultSource(java.lang.String defaultSource) ID of the default payment source for the subscription.
SubscriptionCreateParams.Builder	setDefaultTaxRates(EmptyParam defaultTaxRates) The tax rates that will apply to any subscription item that does not have tax_rates set.
SubscriptionCreateParams.Builder	setDefaultTaxRates(java.util.List<java.lang.String> defaultTaxRates) The tax rates that will apply to any subscription item that does not have tax_rates set.
SubscriptionCreateParams.Builder	setMetadata(EmptyParam metadata) Set of key-value pairs that you can attach to an object.
SubscriptionCreateParams.Builder	setMetadata(java.util.Map<java.lang.String,java.lang.String> metadata) Set of key-value pairs that you can attach to an object.
SubscriptionCreateParams.Builder	setOffSession(java.lang.Boolean offSession) Indicates if a customer is on or off-session while an invoice payment is attempted.
SubscriptionCreateParams.Builder	setPaymentBehavior(SubscriptionCreateParams.PaymentBehavior paymentBehavior) Use allow_incomplete to create subscriptions with status=incomplete if the first invoice cannot be paid.
SubscriptionCreateParams.Builder	setPendingInvoiceItemInterval(EmptyParam pendingInvoiceItemInterval) Specifies an interval for how often to bill for any pending invoice items.
SubscriptionCreateParams.Builder	setPendingInvoiceItemInterval(SubscriptionCreateParams.PendingInvoiceItemInterval pendingInvoiceItemInterval) Specifies an interval for how often to bill for any pending invoice items.
SubscriptionCreateParams.Builder	setPromotionCode(java.lang.String promotionCode) The API ID of a promotion code to apply to this subscription.
SubscriptionCreateParams.Builder	setProrationBehavior(SubscriptionCreateParams.ProrationBehavior prorationBehavior) Determines how to handle prorations resulting from the billing_cycle_anchor.
SubscriptionCreateParams.Builder	setTransferData(SubscriptionCreateParams.TransferData transferData) If specified, the funds from the subscription's invoices will be transferred to the destination and the ID of the resulting transfers will be found on the resulting charges.
SubscriptionCreateParams.Builder	setTrialEnd(java.lang.Long trialEnd) Unix timestamp representing the end of the trial period the customer will get before being charged for the first time.
SubscriptionCreateParams.Builder	setTrialEnd(SubscriptionCreateParams.TrialEnd trialEnd) Unix timestamp representing the end of the trial period the customer will get before being charged for the first time.
SubscriptionCreateParams.Builder	setTrialFromPlan(java.lang.Boolean trialFromPlan) Indicates if a plan's trial_period_days should be applied to the subscription.
SubscriptionCreateParams.Builder	setTrialPeriodDays(java.lang.Long trialPeriodDays) Integer representing the number of trial period days before the customer is charged for the first time.

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

build

public SubscriptionCreateParams build()

Finalize and obtain parameter instance from this builder.

addAddInvoiceItem

public SubscriptionCreateParams.Builder addAddInvoiceItem(SubscriptionCreateParams.AddInvoiceItem element)

Add an element to `addInvoiceItems` list. A list is initialized for the first `add/addAll` call, and subsequent calls adds additional elements to the original list. See SubscriptionCreateParams.addInvoiceItems for the field documentation.

addAllAddInvoiceItem

public SubscriptionCreateParams.Builder addAllAddInvoiceItem(java.util.List<SubscriptionCreateParams.AddInvoiceItem> elements)

Add all elements to `addInvoiceItems` list. A list is initialized for the first `add/addAll` call, and subsequent calls adds additional elements to the original list. See SubscriptionCreateParams.addInvoiceItems for the field documentation.

setApplicationFeePercent

public SubscriptionCreateParams.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.

setBackdateStartDate

public SubscriptionCreateParams.Builder setBackdateStartDate(java.lang.Long backdateStartDate)

For new subscriptions, a past timestamp to backdate the subscription's start date to. If set, the first invoice will contain a proration for the timespan between the start date and the current time. Can be combined with trials and the billing cycle anchor.

setBillingCycleAnchor

public SubscriptionCreateParams.Builder setBillingCycleAnchor(java.lang.Long billingCycleAnchor)

A future timestamp to anchor the subscription's billing cycle. This is used to determine the date of the first full invoice, and, for plans with month or year intervals, the day of the month for subsequent invoices.

setBillingThresholds

public SubscriptionCreateParams.Builder setBillingThresholds(SubscriptionCreateParams.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 SubscriptionCreateParams.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.

setCancelAt

public SubscriptionCreateParams.Builder setCancelAt(java.lang.Long cancelAt)

A timestamp at which the subscription should cancel. If set to a date before the current period ends, this will cause a proration if prorations have been enabled using proration_behavior. If set during a future period, this will always cause a proration for that period.

setCancelAtPeriodEnd

public SubscriptionCreateParams.Builder setCancelAtPeriodEnd(java.lang.Boolean cancelAtPeriodEnd)

Boolean indicating whether this subscription should cancel at the end of the current period.

setCollectionMethod

public SubscriptionCreateParams.Builder setCollectionMethod(SubscriptionCreateParams.CollectionMethod collectionMethod)

Either charge_automatically, or send_invoice. When charging automatically, Stripe will attempt to pay this subscription at the end of the 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.

setCoupon

public SubscriptionCreateParams.Builder setCoupon(java.lang.String coupon)

The code of the coupon to apply to this subscription. A coupon applied to a subscription will only affect invoices created for that particular subscription.

setCustomer

public SubscriptionCreateParams.Builder setCustomer(java.lang.String customer)

The identifier of the customer to subscribe.

setDaysUntilDue

public SubscriptionCreateParams.Builder setDaysUntilDue(java.lang.Long daysUntilDue)

Number of days a customer has to pay invoices generated by this subscription. Valid only for subscriptions where collection_method is set to send_invoice.

setDefaultPaymentMethod

public SubscriptionCreateParams.Builder setDefaultPaymentMethod(java.lang.String defaultPaymentMethod)

ID of the default payment method for the subscription. It must belong to the customer associated with the subscription. This takes precedence over default_source. If neither are set, invoices will use the customer's invoice_settings.default_payment_method or default_source.

setDefaultSource

public SubscriptionCreateParams.Builder setDefaultSource(java.lang.String defaultSource)

ID of the default payment source for the subscription. It must belong to the customer associated with the subscription and be in a chargeable state. If default_payment_method is also set, default_payment_method will take precedence. If neither are set, invoices will use the customer's invoice_settings.default_payment_method or default_source.

addDefaultTaxRate

public SubscriptionCreateParams.Builder addDefaultTaxRate(java.lang.String element)

Add an element to `defaultTaxRates` list. A list is initialized for the first `add/addAll` call, and subsequent calls adds additional elements to the original list. See SubscriptionCreateParams.defaultTaxRates for the field documentation.

addAllDefaultTaxRate

public SubscriptionCreateParams.Builder addAllDefaultTaxRate(java.util.List<java.lang.String> elements)

Add all elements to `defaultTaxRates` list. A list is initialized for the first `add/addAll` call, and subsequent calls adds additional elements to the original list. See SubscriptionCreateParams.defaultTaxRates for the field documentation.

setDefaultTaxRates

public SubscriptionCreateParams.Builder setDefaultTaxRates(EmptyParam defaultTaxRates)

The tax rates that will apply to any subscription item that does not have tax_rates set. Invoices created will have their default_tax_rates populated from the subscription.

setDefaultTaxRates

public SubscriptionCreateParams.Builder setDefaultTaxRates(java.util.List<java.lang.String> defaultTaxRates)

The tax rates that will apply to any subscription item that does not have tax_rates set. Invoices created will have their default_tax_rates populated from the subscription.

addExpand

public SubscriptionCreateParams.Builder addExpand(java.lang.String element)

Add an element to `expand` list. A list is initialized for the first `add/addAll` call, and subsequent calls adds additional elements to the original list. See SubscriptionCreateParams.expand for the field documentation.

addAllExpand

public SubscriptionCreateParams.Builder addAllExpand(java.util.List<java.lang.String> elements)

Add all elements to `expand` list. A list is initialized for the first `add/addAll` call, and subsequent calls adds additional elements to the original list. See SubscriptionCreateParams.expand for the field documentation.

putExtraParam

public SubscriptionCreateParams.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. See SubscriptionCreateParams.extraParams for the field documentation.

putAllExtraParam

public SubscriptionCreateParams.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. See SubscriptionCreateParams.extraParams for the field documentation.

addItem

public SubscriptionCreateParams.Builder addItem(SubscriptionCreateParams.Item element)

Add an element to `items` list. A list is initialized for the first `add/addAll` call, and subsequent calls adds additional elements to the original list. See SubscriptionCreateParams.items for the field documentation.

addAllItem

public SubscriptionCreateParams.Builder addAllItem(java.util.List<SubscriptionCreateParams.Item> elements)

Add all elements to `items` list. A list is initialized for the first `add/addAll` call, and subsequent calls adds additional elements to the original list. See SubscriptionCreateParams.items for the field documentation.

putMetadata

public SubscriptionCreateParams.Builder putMetadata(java.lang.String key,
                                                    java.lang.String value)

Add a key/value pair to `metadata` map. A map is initialized for the first `put/putAll` call, and subsequent calls add additional key/value pairs to the original map. See SubscriptionCreateParams.metadata for the field documentation.

putAllMetadata

public SubscriptionCreateParams.Builder putAllMetadata(java.util.Map<java.lang.String,java.lang.String> map)

Add all map key/value pairs to `metadata` map. A map is initialized for the first `put/putAll` call, and subsequent calls add additional key/value pairs to the original map. See SubscriptionCreateParams.metadata for the field documentation.

setMetadata

public SubscriptionCreateParams.Builder setMetadata(EmptyParam metadata)

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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to metadata.

setMetadata

public SubscriptionCreateParams.Builder setMetadata(java.util.Map<java.lang.String,java.lang.String> metadata)

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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to metadata.

setOffSession

public SubscriptionCreateParams.Builder setOffSession(java.lang.Boolean offSession)

Indicates if a customer is on or off-session while an invoice payment is attempted.

setPaymentBehavior

public SubscriptionCreateParams.Builder setPaymentBehavior(SubscriptionCreateParams.PaymentBehavior paymentBehavior)

Use allow_incomplete to create subscriptions with status=incomplete if the first invoice cannot be paid. Creating subscriptions with this status allows you to manage scenarios where additional user actions are needed to pay a subscription's invoice. For example, SCA regulation may require 3DS authentication to complete payment. See the SCA Migration Guide for Billing to learn more. This is the default behavior.

Use error_if_incomplete if you want Stripe to return an HTTP 402 status code if a subscription's first invoice cannot be paid. For example, if a payment method requires 3DS authentication due to SCA regulation and further user action is needed, this parameter does not create a subscription and returns an error instead. This was the default behavior for API versions prior to 2019-03-14. See the changelog to learn more.

pending_if_incomplete is only used with updates and cannot be passed when creating a subscription.

setPendingInvoiceItemInterval

public SubscriptionCreateParams.Builder setPendingInvoiceItemInterval(SubscriptionCreateParams.PendingInvoiceItemInterval pendingInvoiceItemInterval)

Specifies an interval for how often to bill for any pending invoice items. It is analogous to calling Create an invoice for the given subscription at the specified interval.

setPendingInvoiceItemInterval

public SubscriptionCreateParams.Builder setPendingInvoiceItemInterval(EmptyParam pendingInvoiceItemInterval)

Specifies an interval for how often to bill for any pending invoice items. It is analogous to calling Create an invoice for the given subscription at the specified interval.

setPromotionCode

public SubscriptionCreateParams.Builder setPromotionCode(java.lang.String promotionCode)

The API ID of a promotion code to apply to this subscription. A promotion code applied to a subscription will only affect invoices created for that particular subscription.

setProrationBehavior

public SubscriptionCreateParams.Builder setProrationBehavior(SubscriptionCreateParams.ProrationBehavior prorationBehavior)

Determines how to handle prorations resulting from the billing_cycle_anchor. Valid values are create_prorations or none.

Passing create_prorations will cause proration invoice items to be created when applicable. Prorations can be disabled by passing none. If no value is passed, the default is create_prorations.

setTransferData

public SubscriptionCreateParams.Builder setTransferData(SubscriptionCreateParams.TransferData transferData)

If specified, the funds from the subscription's invoices will be transferred to the destination and the ID of the resulting transfers will be found on the resulting charges.

setTrialEnd

public SubscriptionCreateParams.Builder setTrialEnd(SubscriptionCreateParams.TrialEnd trialEnd)

Unix timestamp representing the end of the trial period the customer will get before being charged for the first time. This will always overwrite any trials that might apply via a subscribed plan. If set, trial_end will override the default trial period of the plan the customer is being subscribed to. The special value now can be provided to end the customer's trial immediately. Can be at most two years from billing_cycle_anchor.

setTrialEnd

public SubscriptionCreateParams.Builder setTrialEnd(java.lang.Long trialEnd)

Unix timestamp representing the end of the trial period the customer will get before being charged for the first time. This will always overwrite any trials that might apply via a subscribed plan. If set, trial_end will override the default trial period of the plan the customer is being subscribed to. The special value now can be provided to end the customer's trial immediately. Can be at most two years from billing_cycle_anchor.

setTrialFromPlan

public SubscriptionCreateParams.Builder setTrialFromPlan(java.lang.Boolean trialFromPlan)

Indicates if a plan's trial_period_days should be applied to the subscription. Setting trial_end per subscription is preferred, and this defaults to false. Setting this flag to true together with trial_end is not allowed.

setTrialPeriodDays

public SubscriptionCreateParams.Builder setTrialPeriodDays(java.lang.Long trialPeriodDays)

Integer representing the number of trial period days before the customer is charged for the first time. This will always overwrite any trials that might apply via a subscribed plan.