Package com.stripe.param

Class SubscriptionScheduleCreateParams.Phase

java.lang.Object
com.stripe.param.SubscriptionScheduleCreateParams.Phase
Enclosing class:
SubscriptionScheduleCreateParams
public static class SubscriptionScheduleCreateParams.Phase extends Object

  • Method Details

    • builder

      public static SubscriptionScheduleCreateParams.Phase.Builder builder()

    • getAddInvoiceItems

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

    • getApplicationFeePercent

      public BigDecimal 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 SubscriptionScheduleCreateParams.Phase.AutomaticTax getAutomaticTax()
      Automatic tax settings for this phase.

    • getBillingCycleAnchor

      public SubscriptionScheduleCreateParams.Phase.BillingCycleAnchor getBillingCycleAnchor()
      Can be set to phase_start to set the anchor to the start of the phase or automatic to automatically change it if needed. Cannot be set to phase_start if this phase specifies a trial. For more information, see the billing cycle documentation.

    • 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.

    • getCollectionMethod

      public SubscriptionScheduleCreateParams.Phase.CollectionMethod getCollectionMethod()
      Either charge_automatically, or send_invoice. When charging automatically, Stripe will attempt to pay the underlying subscription at the end of each billing 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 on creation.

    • getCoupon

      public String getCoupon()
      The ID of the coupon to apply to this phase of the subscription schedule. 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.

    • getDefaultPaymentMethod

      public String getDefaultPaymentMethod()
      ID of the default payment method for the subscription schedule. It must belong to the customer associated with the subscription schedule. If not set, invoices will use the default payment method in the customer's invoice settings.

    • getDefaultTaxRates

      public Object getDefaultTaxRates()
      A list of Tax Rate ids. These Tax Rates will set the Subscription's default_tax_rates, which means they will be the Invoice's default_tax_rates for any Invoices issued by the Subscription during this Phase.

    • getDescription

      public Object getDescription()
      Subscription 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 schedule phase. If not specified, inherits the discount from the subscription's customer. Pass an empty string to avoid inheriting any discounts.

    • getEndDate

      public Long getEndDate()
      The date at which this phase of the subscription schedule ends. If set, iterations must not be set.

    • 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 SubscriptionScheduleCreateParams.Phase.InvoiceSettings getInvoiceSettings()
      All invoices will be billed using the specified settings.

    • getItems

      public List<SubscriptionScheduleCreateParams.Phase.Item> getItems()
      Required. List of configuration items, each with an attached price, to apply during this phase of the subscription schedule.

    • getIterations

      public Long getIterations()
      Integer representing the multiplier applied to the price interval. For example, iterations=2 applied to a price with interval=month and interval_count=3 results in a phase of duration 2 * 3 months = 6 months. If set, end_date must not be set.

    • getMetadata

      public Map<String,String> getMetadata()
      Set of key-value pairs that you can attach to a phase. Metadata on a schedule's phase will update the underlying subscription's metadata when the phase is entered, adding new keys and replacing existing keys in the subscription's metadata. Individual keys in the subscription's metadata can be unset by posting an empty value to them in the phase's metadata. To unset all keys in the subscription's metadata, update the subscription directly or unset every key individually from the phase's metadata.

    • getOnBehalfOf

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

    • getProrationBehavior

      public SubscriptionScheduleCreateParams.Phase.ProrationBehavior getProrationBehavior()
      Whether the subscription schedule will create prorations when transitioning to this phase. The default value is create_prorations. This setting controls prorations when a phase is started asynchronously and it is persisted as a field on the phase. It's different from the request-level proration_behavior parameter which controls what happens if the update request affects the billing configuration of the current phase.

    • getTransferData

      public SubscriptionScheduleCreateParams.Phase.TransferData getTransferData()
      The data with which to automatically create a Transfer for each of the associated subscription's invoices.

    • getTrial

      public Boolean getTrial()
      If set to true the entire phase is counted as a trial and the customer will not be charged for any fees.

    • getTrialEnd

      public Long getTrialEnd()
      Sets the phase to trialing from the start date to this date. Must be before the phase end date, can not be combined with trial