Package com.stripe.param

Class SubscriptionUpdateParams.Builder

java.lang.Object
com.stripe.param.SubscriptionUpdateParams.Builder
Enclosing class:
SubscriptionUpdateParams
public static class SubscriptionUpdateParams.Builder extends Object

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • 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. See SubscriptionUpdateParams.addInvoiceItems for the field documentation.

    • addAllAddInvoiceItem

      public SubscriptionUpdateParams.Builder addAllAddInvoiceItem(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. See SubscriptionUpdateParams.addInvoiceItems for the field documentation.

    • setApplicationFeePercent

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

    • setApplicationFeePercent

      public SubscriptionUpdateParams.Builder setApplicationFeePercent(EmptyParam 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 SubscriptionUpdateParams.Builder setAutomaticTax(SubscriptionUpdateParams.AutomaticTax automaticTax)
      Automatic tax settings for this subscription. We recommend you only include this parameter when the existing value is being changed.

    • setBillingCycleAnchor

      public SubscriptionUpdateParams.Builder setBillingCycleAnchor(SubscriptionUpdateParams.BillingCycleAnchor billingCycleAnchor)
      Either now or unchanged. Setting the value to now resets the subscription's billing cycle anchor to the current time (in UTC). 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(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.

    • 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 using proration_behavior. If set during a future period, this will always cause a proration for that period.

    • setCancelAtPeriodEnd

      public SubscriptionUpdateParams.Builder setCancelAtPeriodEnd(Boolean cancelAtPeriodEnd)
      Indicate whether this subscription should cancel at the end of the current period ( current_period_end). Defaults to false.

    • setCancellationDetails

      public SubscriptionUpdateParams.Builder setCancellationDetails(SubscriptionUpdateParams.CancellationDetails cancellationDetails)
      Details about why this subscription was cancelled.

    • setCollectionMethod

      public SubscriptionUpdateParams.Builder setCollectionMethod(SubscriptionUpdateParams.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 and mark the subscription as active. Defaults to charge_automatically.

    • setCoupon

      public SubscriptionUpdateParams.Builder setCoupon(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. This field has been deprecated and will be removed in a future API version. Use discounts instead.

    • 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. This field has been deprecated and will be removed in a future API version. Use discounts instead.

    • setDaysUntilDue

      public SubscriptionUpdateParams.Builder setDaysUntilDue(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 SubscriptionUpdateParams.Builder setDefaultPaymentMethod(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.

    • 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 over default_source. If neither are set, invoices will use the customer's invoice_settings.default_payment_method or default_source.

    • setDefaultSource

      public SubscriptionUpdateParams.Builder setDefaultSource(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.

    • 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. 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 SubscriptionUpdateParams.Builder addDefaultTaxRate(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 SubscriptionUpdateParams.defaultTaxRates for the field documentation.

    • addAllDefaultTaxRate

      public SubscriptionUpdateParams.Builder addAllDefaultTaxRate(List<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 SubscriptionUpdateParams.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 have tax_rates set. Invoices created will have their default_tax_rates populated from the subscription. Pass an empty string to remove previously-defined tax rates.

    • setDefaultTaxRates

      public SubscriptionUpdateParams.Builder setDefaultTaxRates(List<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. Pass an empty string to remove previously-defined tax rates.

    • setDescription

      public SubscriptionUpdateParams.Builder setDescription(String description)
      The subscription's 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 SubscriptionUpdateParams.Builder setDescription(EmptyParam description)
      The subscription's 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.

    • addDiscount

      public SubscriptionUpdateParams.Builder addDiscount(SubscriptionUpdateParams.Discount element)
      Add an element to `discounts` list. A list is initialized for the first `add/addAll` call, and subsequent calls adds additional elements to the original list. See SubscriptionUpdateParams.discounts for the field documentation.

    • addAllDiscount

      public SubscriptionUpdateParams.Builder addAllDiscount(List<SubscriptionUpdateParams.Discount> elements)
      Add all elements to `discounts` list. A list is initialized for the first `add/addAll` call, and subsequent calls adds additional elements to the original list. See SubscriptionUpdateParams.discounts for the field documentation.

    • setDiscounts

      public SubscriptionUpdateParams.Builder setDiscounts(EmptyParam discounts)
      The coupons to redeem into discounts for the subscription. If not specified or empty, inherits the discount from the subscription's customer.

    • setDiscounts

      public SubscriptionUpdateParams.Builder setDiscounts(List<SubscriptionUpdateParams.Discount> discounts)
      The coupons to redeem into discounts for the subscription. If not specified or empty, inherits the discount from the subscription's customer.

    • addExpand

      public SubscriptionUpdateParams.Builder addExpand(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 SubscriptionUpdateParams.expand for the field documentation.

    • addAllExpand

      public SubscriptionUpdateParams.Builder addAllExpand(List<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 SubscriptionUpdateParams.expand for the field documentation.

    • putExtraParam

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

    • putAllExtraParam

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

    • setInvoiceSettings

      public SubscriptionUpdateParams.Builder setInvoiceSettings(SubscriptionUpdateParams.InvoiceSettings invoiceSettings)
      All invoices will be billed using the specified settings.

    • 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. See SubscriptionUpdateParams.items for the field documentation.

    • addAllItem

      public SubscriptionUpdateParams.Builder addAllItem(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. See SubscriptionUpdateParams.items for the field documentation.

    • putMetadata

      public SubscriptionUpdateParams.Builder putMetadata(String key, 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 SubscriptionUpdateParams.metadata for the field documentation.

    • putAllMetadata

      public SubscriptionUpdateParams.Builder putAllMetadata(Map<String,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 SubscriptionUpdateParams.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 to metadata.

    • setMetadata

      public SubscriptionUpdateParams.Builder setMetadata(Map<String,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 SubscriptionUpdateParams.Builder setOffSession(Boolean offSession)
      Indicates if a customer is on or off-session while an invoice payment is attempted. Defaults to false (on-session).

    • setOnBehalfOf

      public SubscriptionUpdateParams.Builder setOnBehalfOf(String onBehalfOf)
      The account on behalf of which to charge, for each of the subscription's invoices.

    • setOnBehalfOf

      public SubscriptionUpdateParams.Builder setOnBehalfOf(EmptyParam onBehalfOf)
      The account on behalf of which to charge, for each of the subscription's invoices.

    • setPauseCollection

      public SubscriptionUpdateParams.Builder setPauseCollection(SubscriptionUpdateParams.PauseCollection pauseCollection)
      If specified, payment collection for this subscription will be paused. Note that the subscription status will be unchanged and will not be updated to paused. Learn more about pausing collection.

    • setPauseCollection

      public SubscriptionUpdateParams.Builder setPauseCollection(EmptyParam pauseCollection)
      If specified, payment collection for this subscription will be paused. Note that the subscription status will be unchanged and will not be updated to paused. Learn more about pausing collection.

    • setPaymentBehavior

      public SubscriptionUpdateParams.Builder setPaymentBehavior(SubscriptionUpdateParams.PaymentBehavior paymentBehavior)
      Use allow_incomplete to transition the subscription to status=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 to status=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 use pending_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(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. This field has been deprecated and will be removed in a future API version. Use discounts instead.

    • 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. This field has been deprecated and will be removed in a future API version. Use discounts instead.

    • setProrationBehavior

      public SubscriptionUpdateParams.Builder setProrationBehavior(SubscriptionUpdateParams.ProrationBehavior prorationBehavior)
      Determines how to handle prorations when the billing cycle changes (e.g., when switching plans, resetting billing_cycle_anchor=now, or starting a trial), or if an item's quantity changes. The default value is create_prorations.

    • setProrationDate

      public SubscriptionUpdateParams.Builder setProrationDate(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 value now can be provided to end the customer's trial immediately. Can be at most two years from billing_cycle_anchor.

    • setTrialEnd

      public SubscriptionUpdateParams.Builder setTrialEnd(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 SubscriptionUpdateParams.Builder setTrialFromPlan(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. See Using trial periods on subscriptions to learn more.

    • setTrialSettings

      public SubscriptionUpdateParams.Builder setTrialSettings(SubscriptionUpdateParams.TrialSettings trialSettings)
      Settings related to subscription trials.