Class SubscriptionUpdateParams.Builder
- java.lang.Object
-
- com.stripe.param.SubscriptionUpdateParams.Builder
-
- Enclosing class:
- SubscriptionUpdateParams
public static class SubscriptionUpdateParams.Builder extends java.lang.Object
-
-
Constructor Summary
Constructors Constructor Description Builder()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description SubscriptionUpdateParams.Builder
addAddInvoiceItem(SubscriptionUpdateParams.AddInvoiceItem element)
Add an element to `addInvoiceItems` list.SubscriptionUpdateParams.Builder
addAllAddInvoiceItem(java.util.List<SubscriptionUpdateParams.AddInvoiceItem> elements)
Add all elements to `addInvoiceItems` list.SubscriptionUpdateParams.Builder
addAllDefaultTaxRate(java.util.List<java.lang.String> elements)
Add all elements to `defaultTaxRates` list.SubscriptionUpdateParams.Builder
addAllExpand(java.util.List<java.lang.String> elements)
Add all elements to `expand` list.SubscriptionUpdateParams.Builder
addAllItem(java.util.List<SubscriptionUpdateParams.Item> elements)
Add all elements to `items` list.SubscriptionUpdateParams.Builder
addDefaultTaxRate(java.lang.String element)
Add an element to `defaultTaxRates` list.SubscriptionUpdateParams.Builder
addExpand(java.lang.String element)
Add an element to `expand` list.SubscriptionUpdateParams.Builder
addItem(SubscriptionUpdateParams.Item element)
Add an element to `items` list.SubscriptionUpdateParams
build()
Finalize and obtain parameter instance from this builder.SubscriptionUpdateParams.Builder
putAllExtraParam(java.util.Map<java.lang.String,java.lang.Object> map)
Add all map key/value pairs to `extraParams` map.SubscriptionUpdateParams.Builder
putAllMetadata(java.util.Map<java.lang.String,java.lang.String> map)
Add all map key/value pairs to `metadata` map.SubscriptionUpdateParams.Builder
putExtraParam(java.lang.String key, java.lang.Object value)
Add a key/value pair to `extraParams` map.SubscriptionUpdateParams.Builder
putMetadata(java.lang.String key, java.lang.String value)
Add a key/value pair to `metadata` map.SubscriptionUpdateParams.Builder
setApplicationFeePercent(java.math.BigDecimal applicationFeePercent)
A non-negative decimal between 0 and 100, with at most two decimal places.SubscriptionUpdateParams.Builder
setAutomaticTax(SubscriptionUpdateParams.AutomaticTax automaticTax)
Automatic tax settings for this subscription.SubscriptionUpdateParams.Builder
setBillingCycleAnchor(SubscriptionUpdateParams.BillingCycleAnchor billingCycleAnchor)
Eithernow
orunchanged
.SubscriptionUpdateParams.Builder
setBillingThresholds(EmptyParam billingThresholds)
Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period.SubscriptionUpdateParams.Builder
setBillingThresholds(SubscriptionUpdateParams.BillingThresholds billingThresholds)
Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period.SubscriptionUpdateParams.Builder
setCancelAt(EmptyParam cancelAt)
A timestamp at which the subscription should cancel.SubscriptionUpdateParams.Builder
setCancelAt(java.lang.Long cancelAt)
A timestamp at which the subscription should cancel.SubscriptionUpdateParams.Builder
setCancelAtPeriodEnd(java.lang.Boolean cancelAtPeriodEnd)
Boolean indicating whether this subscription should cancel at the end of the current period.SubscriptionUpdateParams.Builder
setCollectionMethod(SubscriptionUpdateParams.CollectionMethod collectionMethod)
Eithercharge_automatically
, orsend_invoice
.SubscriptionUpdateParams.Builder
setCoupon(EmptyParam coupon)
The ID of the coupon to apply to this subscription.SubscriptionUpdateParams.Builder
setCoupon(java.lang.String coupon)
The ID of the coupon to apply to this subscription.SubscriptionUpdateParams.Builder
setDaysUntilDue(java.lang.Long daysUntilDue)
Number of days a customer has to pay invoices generated by this subscription.SubscriptionUpdateParams.Builder
setDefaultPaymentMethod(EmptyParam defaultPaymentMethod)
ID of the default payment method for the subscription.SubscriptionUpdateParams.Builder
setDefaultPaymentMethod(java.lang.String defaultPaymentMethod)
ID of the default payment method for the subscription.SubscriptionUpdateParams.Builder
setDefaultSource(EmptyParam defaultSource)
ID of the default payment source for the subscription.SubscriptionUpdateParams.Builder
setDefaultSource(java.lang.String defaultSource)
ID of the default payment source for the subscription.SubscriptionUpdateParams.Builder
setDefaultTaxRates(EmptyParam defaultTaxRates)
The tax rates that will apply to any subscription item that does not havetax_rates
set.SubscriptionUpdateParams.Builder
setDefaultTaxRates(java.util.List<java.lang.String> defaultTaxRates)
The tax rates that will apply to any subscription item that does not havetax_rates
set.SubscriptionUpdateParams.Builder
setMetadata(EmptyParam metadata)
Set of key-value pairs that you can attach to an object.SubscriptionUpdateParams.Builder
setMetadata(java.util.Map<java.lang.String,java.lang.String> metadata)
Set of key-value pairs that you can attach to an object.SubscriptionUpdateParams.Builder
setOffSession(java.lang.Boolean offSession)
Indicates if a customer is on or off-session while an invoice payment is attempted.SubscriptionUpdateParams.Builder
setPauseCollection(EmptyParam pauseCollection)
If specified, payment collection for this subscription will be paused.SubscriptionUpdateParams.Builder
setPauseCollection(SubscriptionUpdateParams.PauseCollection pauseCollection)
If specified, payment collection for this subscription will be paused.SubscriptionUpdateParams.Builder
setPaymentBehavior(SubscriptionUpdateParams.PaymentBehavior paymentBehavior)
Useallow_incomplete
to transition the subscription tostatus=past_due
if a payment is required but cannot be paid.SubscriptionUpdateParams.Builder
setPaymentSettings(SubscriptionUpdateParams.PaymentSettings paymentSettings)
Payment settings to pass to invoices created by the subscription.SubscriptionUpdateParams.Builder
setPendingInvoiceItemInterval(EmptyParam pendingInvoiceItemInterval)
Specifies an interval for how often to bill for any pending invoice items.SubscriptionUpdateParams.Builder
setPendingInvoiceItemInterval(SubscriptionUpdateParams.PendingInvoiceItemInterval pendingInvoiceItemInterval)
Specifies an interval for how often to bill for any pending invoice items.SubscriptionUpdateParams.Builder
setPromotionCode(EmptyParam promotionCode)
The promotion code to apply to this subscription.SubscriptionUpdateParams.Builder
setPromotionCode(java.lang.String promotionCode)
The promotion code to apply to this subscription.SubscriptionUpdateParams.Builder
setProrationBehavior(SubscriptionUpdateParams.ProrationBehavior prorationBehavior)
Determines how to handle prorations when the billing cycle changes (e.g., when switching plans, resettingbilling_cycle_anchor=now
, or starting a trial), or if an item'squantity
changes.SubscriptionUpdateParams.Builder
setProrationDate(java.lang.Long prorationDate)
If set, the proration will be calculated as though the subscription was updated at the given time.SubscriptionUpdateParams.Builder
setTransferData(EmptyParam 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.SubscriptionUpdateParams.Builder
setTransferData(SubscriptionUpdateParams.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.SubscriptionUpdateParams.Builder
setTrialEnd(SubscriptionUpdateParams.TrialEnd trialEnd)
Unix timestamp representing the end of the trial period the customer will get before being charged for the first time.SubscriptionUpdateParams.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.SubscriptionUpdateParams.Builder
setTrialFromPlan(java.lang.Boolean trialFromPlan)
Indicates if a plan'strial_period_days
should be applied to the subscription.
-
-
-
Method Detail
-
build
public SubscriptionUpdateParams build()
Finalize and obtain parameter instance from this builder.
-
addAddInvoiceItem
public SubscriptionUpdateParams.Builder addAddInvoiceItem(SubscriptionUpdateParams.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. SeeSubscriptionUpdateParams.addInvoiceItems
for the field documentation.
-
addAllAddInvoiceItem
public SubscriptionUpdateParams.Builder addAllAddInvoiceItem(java.util.List<SubscriptionUpdateParams.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. SeeSubscriptionUpdateParams.addInvoiceItems
for the field documentation.
-
setApplicationFeePercent
public SubscriptionUpdateParams.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 SubscriptionUpdateParams.Builder setAutomaticTax(SubscriptionUpdateParams.AutomaticTax automaticTax)
Automatic tax settings for this subscription.
-
setBillingCycleAnchor
public SubscriptionUpdateParams.Builder setBillingCycleAnchor(SubscriptionUpdateParams.BillingCycleAnchor billingCycleAnchor)
Eithernow
orunchanged
. Setting the value tonow
resets the subscription's billing cycle anchor to the current time. For more information, see the billing cycle documentation.
-
setBillingThresholds
public SubscriptionUpdateParams.Builder setBillingThresholds(SubscriptionUpdateParams.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 SubscriptionUpdateParams.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 SubscriptionUpdateParams.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 usingproration_behavior
. If set during a future period, this will always cause a proration for that period.
-
setCancelAt
public SubscriptionUpdateParams.Builder setCancelAt(EmptyParam 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 usingproration_behavior
. If set during a future period, this will always cause a proration for that period.
-
setCancelAtPeriodEnd
public SubscriptionUpdateParams.Builder setCancelAtPeriodEnd(java.lang.Boolean cancelAtPeriodEnd)
Boolean indicating whether this subscription should cancel at the end of the current period.
-
setCollectionMethod
public SubscriptionUpdateParams.Builder setCollectionMethod(SubscriptionUpdateParams.CollectionMethod collectionMethod)
Eithercharge_automatically
, orsend_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 tocharge_automatically
.
-
setCoupon
public SubscriptionUpdateParams.Builder setCoupon(java.lang.String coupon)
The ID of the coupon to apply to this subscription. A coupon applied to a subscription will only affect invoices created for that particular subscription.
-
setCoupon
public SubscriptionUpdateParams.Builder setCoupon(EmptyParam coupon)
The ID of the coupon to apply to this subscription. A coupon applied to a subscription will only affect invoices created for that particular subscription.
-
setDaysUntilDue
public SubscriptionUpdateParams.Builder setDaysUntilDue(java.lang.Long daysUntilDue)
Number of days a customer has to pay invoices generated by this subscription. Valid only for subscriptions wherecollection_method
is set tosend_invoice
.
-
setDefaultPaymentMethod
public SubscriptionUpdateParams.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 overdefault_source
. If neither are set, invoices will use the customer's invoice_settings.default_payment_method or default_source.
-
setDefaultPaymentMethod
public SubscriptionUpdateParams.Builder setDefaultPaymentMethod(EmptyParam defaultPaymentMethod)
ID of the default payment method for the subscription. It must belong to the customer associated with the subscription. This takes precedence overdefault_source
. If neither are set, invoices will use the customer's invoice_settings.default_payment_method or default_source.
-
setDefaultSource
public SubscriptionUpdateParams.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. Ifdefault_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.
-
setDefaultSource
public SubscriptionUpdateParams.Builder setDefaultSource(EmptyParam 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. Ifdefault_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 SubscriptionUpdateParams.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. SeeSubscriptionUpdateParams.defaultTaxRates
for the field documentation.
-
addAllDefaultTaxRate
public SubscriptionUpdateParams.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. SeeSubscriptionUpdateParams.defaultTaxRates
for the field documentation.
-
setDefaultTaxRates
public SubscriptionUpdateParams.Builder setDefaultTaxRates(EmptyParam defaultTaxRates)
The tax rates that will apply to any subscription item that does not havetax_rates
set. Invoices created will have theirdefault_tax_rates
populated from the subscription. Pass an empty string to remove previously-defined tax rates.
-
setDefaultTaxRates
public SubscriptionUpdateParams.Builder setDefaultTaxRates(java.util.List<java.lang.String> defaultTaxRates)
The tax rates that will apply to any subscription item that does not havetax_rates
set. Invoices created will have theirdefault_tax_rates
populated from the subscription. Pass an empty string to remove previously-defined tax rates.
-
addExpand
public SubscriptionUpdateParams.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. SeeSubscriptionUpdateParams.expand
for the field documentation.
-
addAllExpand
public SubscriptionUpdateParams.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. SeeSubscriptionUpdateParams.expand
for the field documentation.
-
putExtraParam
public SubscriptionUpdateParams.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. SeeSubscriptionUpdateParams.extraParams
for the field documentation.
-
putAllExtraParam
public SubscriptionUpdateParams.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. SeeSubscriptionUpdateParams.extraParams
for the field documentation.
-
addItem
public SubscriptionUpdateParams.Builder addItem(SubscriptionUpdateParams.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. SeeSubscriptionUpdateParams.items
for the field documentation.
-
addAllItem
public SubscriptionUpdateParams.Builder addAllItem(java.util.List<SubscriptionUpdateParams.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. SeeSubscriptionUpdateParams.items
for the field documentation.
-
putMetadata
public SubscriptionUpdateParams.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. SeeSubscriptionUpdateParams.metadata
for the field documentation.
-
putAllMetadata
public SubscriptionUpdateParams.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. SeeSubscriptionUpdateParams.metadata
for the field documentation.
-
setMetadata
public SubscriptionUpdateParams.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 tometadata
.
-
setMetadata
public SubscriptionUpdateParams.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 tometadata
.
-
setOffSession
public SubscriptionUpdateParams.Builder setOffSession(java.lang.Boolean offSession)
Indicates if a customer is on or off-session while an invoice payment is attempted.
-
setPauseCollection
public SubscriptionUpdateParams.Builder setPauseCollection(SubscriptionUpdateParams.PauseCollection pauseCollection)
If specified, payment collection for this subscription will be paused.
-
setPauseCollection
public SubscriptionUpdateParams.Builder setPauseCollection(EmptyParam pauseCollection)
If specified, payment collection for this subscription will be paused.
-
setPaymentBehavior
public SubscriptionUpdateParams.Builder setPaymentBehavior(SubscriptionUpdateParams.PaymentBehavior paymentBehavior)
Useallow_incomplete
to transition the subscription tostatus=past_due
if a payment is required but cannot be paid. This 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
default_incomplete
to transition the subscription tostatus=past_due
when payment is required and await explicit confirmation of the invoice's payment intent. This allows simpler management of scenarios where additional user actions are needed to pay a subscription’s invoice. Such as failed payments, SCA regulation, or collecting a mandate for a bank debit payment method.Use
pending_if_incomplete
to update the subscription using pending updates. When you usepending_if_incomplete
you can only pass the parameters supported by pending updates.Use
error_if_incomplete
if you want Stripe to return an HTTP 402 status code if a subscription's 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 update the 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.
-
setPaymentSettings
public SubscriptionUpdateParams.Builder setPaymentSettings(SubscriptionUpdateParams.PaymentSettings paymentSettings)
Payment settings to pass to invoices created by the subscription.
-
setPendingInvoiceItemInterval
public SubscriptionUpdateParams.Builder setPendingInvoiceItemInterval(SubscriptionUpdateParams.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 SubscriptionUpdateParams.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 SubscriptionUpdateParams.Builder setPromotionCode(java.lang.String promotionCode)
The promotion code to apply to this subscription. A promotion code applied to a subscription will only affect invoices created for that particular subscription.
-
setPromotionCode
public SubscriptionUpdateParams.Builder setPromotionCode(EmptyParam promotionCode)
The 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 SubscriptionUpdateParams.Builder setProrationBehavior(SubscriptionUpdateParams.ProrationBehavior prorationBehavior)
Determines how to handle prorations when the billing cycle changes (e.g., when switching plans, resettingbilling_cycle_anchor=now
, or starting a trial), or if an item'squantity
changes. Valid values arecreate_prorations
,none
, oralways_invoice
.Passing
create_prorations
will cause proration invoice items to be created when applicable. These proration items will only be invoiced immediately under certain conditions. In order to always invoice immediately for prorations, passalways_invoice
.Prorations can be disabled by passing
none
.
-
setProrationDate
public SubscriptionUpdateParams.Builder setProrationDate(java.lang.Long prorationDate)
If set, the proration will be calculated as though the subscription was updated at the given time. This can be used to apply exactly the same proration that was previewed with upcoming invoice endpoint. It can also be used to implement custom proration logic, such as prorating by day instead of by second, by providing the time that you wish to use for proration calculations.
-
setTransferData
public SubscriptionUpdateParams.Builder setTransferData(SubscriptionUpdateParams.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. This will be unset if you POST an empty value.
-
setTransferData
public SubscriptionUpdateParams.Builder setTransferData(EmptyParam 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. This will be unset if you POST an empty value.
-
setTrialEnd
public SubscriptionUpdateParams.Builder setTrialEnd(SubscriptionUpdateParams.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 valuenow
can be provided to end the customer's trial immediately. Can be at most two years frombilling_cycle_anchor
.
-
setTrialEnd
public SubscriptionUpdateParams.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 valuenow
can be provided to end the customer's trial immediately. Can be at most two years frombilling_cycle_anchor
.
-
setTrialFromPlan
public SubscriptionUpdateParams.Builder setTrialFromPlan(java.lang.Boolean trialFromPlan)
Indicates if a plan'strial_period_days
should be applied to the subscription. Settingtrial_end
per subscription is preferred, and this defaults tofalse
. Setting this flag totrue
together withtrial_end
is not allowed.
-
-