Class SubscriptionCreateParams


public class SubscriptionCreateParams extends ApiRequestParams
  • Method Details

    • builder

      public static SubscriptionCreateParams.Builder builder()
    • getAddInvoiceItems

      public List<SubscriptionCreateParams.AddInvoiceItem> getAddInvoiceItems()
      A list of prices and quantities that will generate invoice items appended to the next invoice for this subscription. You may pass up to 20 items.
    • getApplicationFeePercent

      public Object getApplicationFeePercent()
      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.
    • getAutomaticTax

      public SubscriptionCreateParams.AutomaticTax getAutomaticTax()
      Automatic tax settings for this subscription. We recommend you only include this parameter when the existing value is being changed.
    • getBackdateStartDate

      public Long getBackdateStartDate()
      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.
    • getBillingCycleAnchor

      public Long getBillingCycleAnchor()
      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.
    • getBillingCycleAnchorConfig

      public SubscriptionCreateParams.BillingCycleAnchorConfig getBillingCycleAnchorConfig()
      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.
    • getBillingThresholds

      public Object getBillingThresholds()
      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.
    • getCancelAt

      public Long getCancelAt()
      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.
    • getCancelAtPeriodEnd

      public Boolean getCancelAtPeriodEnd()
      Boolean indicating whether this subscription should cancel at the end of the current period.
    • getCollectionMethod

      public SubscriptionCreateParams.CollectionMethod getCollectionMethod()
      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.
    • getCoupon

      public String getCoupon()
      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.
    • getCurrency

      public String getCurrency()
      Three-letter ISO currency code, in lowercase. Must be a supported currency.
    • getCustomer

      public String getCustomer()
      Required. The identifier of the customer to subscribe.
    • getDaysUntilDue

      public Long getDaysUntilDue()
      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.
    • getDefaultPaymentMethod

      public String getDefaultPaymentMethod()
      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.
    • getDefaultSource

      public String getDefaultSource()
      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.
    • getDefaultTaxRates

      public Object getDefaultTaxRates()
      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.
    • getDescription

      public String getDescription()
      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.
    • getDiscounts

      public Object getDiscounts()
      The coupons to redeem into discounts for the subscription. If not specified or empty, inherits the discount from the subscription's customer.
    • getExpand

      public List<String> getExpand()
      Specifies which fields in the response should be expanded.
    • getExtraParams

      public Map<String,Object> getExtraParams()
      Map of extra parameters for custom features not available in this client library. The content in this map is not serialized under this field's @SerializedName value. Instead, each key/value pair is serialized as if the key is a root-level field (serialized) name in this param object. Effectively, this map is flattened to its parent instance.
    • getInvoiceSettings

      public SubscriptionCreateParams.InvoiceSettings getInvoiceSettings()
      All invoices will be billed using the specified settings.
    • getItems

      public List<SubscriptionCreateParams.Item> getItems()
      A list of up to 20 subscription items, each with an attached price.
    • getMetadata

      public Object getMetadata()
      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.
    • getOffSession

      public Boolean getOffSession()
      Indicates if a customer is on or off-session while an invoice payment is attempted.
    • getOnBehalfOf

      public Object getOnBehalfOf()
      The account on behalf of which to charge, for each of the subscription's invoices.
    • getPaymentBehavior

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

    • getPaymentSettings

      public SubscriptionCreateParams.PaymentSettings getPaymentSettings()
      Payment settings to pass to invoices created by the subscription.
    • getPendingInvoiceItemInterval

      public Object getPendingInvoiceItemInterval()
      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.
    • getPromotionCode

      public String getPromotionCode()
      The 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. This field has been deprecated and will be removed in a future API version. Use discounts instead.
    • getProrationBehavior

      public SubscriptionCreateParams.ProrationBehavior getProrationBehavior()
      Determines how to handle prorations resulting from the billing_cycle_anchor. If no value is passed, the default is create_prorations.
    • getTransferData

      public SubscriptionCreateParams.TransferData getTransferData()
      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.
    • getTrialEnd

      public Object getTrialEnd()
      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.
    • getTrialFromPlan

      public Boolean getTrialFromPlan()
      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.
    • getTrialPeriodDays

      public Long getTrialPeriodDays()
      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.
    • getTrialSettings

      public SubscriptionCreateParams.TrialSettings getTrialSettings()
      Settings related to subscription trials.