Package com.stripe.param

Class SubscriptionCreateParams.Builder

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

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

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

    • setBackdateStartDate

      public SubscriptionCreateParams.Builder setBackdateStartDate(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(Long billingCycleAnchor)
      A future timestamp in UTC format to anchor the subscription's billing cycle. The anchor is the reference point that aligns future billing cycle dates. It sets the day of week for week intervals, the day of month for month and year intervals, and the month of year for year intervals.

    • setBillingCycleAnchorConfig

      public SubscriptionCreateParams.Builder setBillingCycleAnchorConfig(SubscriptionCreateParams.BillingCycleAnchorConfig billingCycleAnchorConfig)
      Mutually exclusive with billing_cycle_anchor and only valid with monthly and yearly price intervals. When provided, the billing_cycle_anchor is set to the next occurence of the day_of_month at the hour, minute, and second UTC.

    • 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(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(Boolean cancelAtPeriodEnd)
      Indicate whether this subscription should cancel at the end of the current period ( current_period_end). Defaults to false.

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

    • setCoupon

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

    • setCurrency

      public SubscriptionCreateParams.Builder setCurrency(String currency)
      Three-letter ISO currency code, in lowercase. Must be a supported currency.

    • setCustomer

      public SubscriptionCreateParams.Builder setCustomer(String customer)
      Required. The identifier of the customer to subscribe.

    • setDaysUntilDue

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

    • setDefaultSource

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

    • addDefaultTaxRate

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

    • addAllDefaultTaxRate

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

    • setDescription

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

    • addDiscount

      public SubscriptionCreateParams.Builder addDiscount(SubscriptionCreateParams.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 SubscriptionCreateParams.discounts for the field documentation.

    • addAllDiscount

      public SubscriptionCreateParams.Builder addAllDiscount(List<SubscriptionCreateParams.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 SubscriptionCreateParams.discounts for the field documentation.

    • setDiscounts

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

    • addAllExpand

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

    • putExtraParam

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

    • putAllExtraParam

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

    • setInvoiceSettings

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

    • 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(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(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 SubscriptionCreateParams.metadata for the field documentation.

    • putAllMetadata

      public SubscriptionCreateParams.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 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(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 SubscriptionCreateParams.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 SubscriptionCreateParams.Builder setOnBehalfOf(String onBehalfOf)
      The account on behalf of which to charge, for each of the subscription's invoices.

    • setOnBehalfOf

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

    • setPaymentBehavior

      public SubscriptionCreateParams.Builder setPaymentBehavior(SubscriptionCreateParams.PaymentBehavior paymentBehavior)
      Only applies to subscriptions with collection_method=charge_automatically.

      Use allow_incomplete to create Subscriptions with status=incomplete if the first invoice can't be paid. Creating Subscriptions with this status allows you to manage scenarios where additional customer 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 create Subscriptions with status=incomplete when the first invoice requires payment, otherwise start as active. Subscriptions transition to status=active when successfully confirming the PaymentIntent on the first invoice. This allows simpler management of scenarios where additional customer 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. If the PaymentIntent is not confirmed within 23 hours Subscriptions transition to status=incomplete_expired, which is a terminal state.

      Use error_if_incomplete if you want Stripe to return an HTTP 402 status code if a subscription's first invoice can't be paid. For example, if a payment method requires 3DS authentication due to SCA regulation and further customer action is needed, this parameter doesn't 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.

      Subscriptions with collection_method=send_invoice are automatically activated regardless of the first Invoice status.

    • setPaymentSettings

      public SubscriptionCreateParams.Builder setPaymentSettings(SubscriptionCreateParams.PaymentSettings paymentSettings)
      Payment settings to pass to invoices created by the 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(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.

    • setProrationBehavior

      public SubscriptionCreateParams.Builder setProrationBehavior(SubscriptionCreateParams.ProrationBehavior prorationBehavior)
      Determines how to handle prorations resulting from the billing_cycle_anchor. 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. 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. See Using trial periods on subscriptions to learn more.

    • setTrialEnd

      public SubscriptionCreateParams.Builder setTrialEnd(Long trialEnd)
      Unix timestamp representing the end of the trial period the customer will get before being charged for the first time. 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. See Using trial periods on subscriptions to learn more.

    • setTrialFromPlan

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

    • setTrialPeriodDays

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

    • setTrialSettings

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