Class SubscriptionScheduleCreateParams.Phase

    • Method Detail

      • getApplicationFeePercent

        public java.math.BigDecimal getApplicationFeePercent()
        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.
      • 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 java.lang.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. Defaults to charge_automatically on creation.
      • getCoupon

        public java.lang.String getCoupon()
        The identifier of the coupon to apply to this phase of the subscription schedule.
      • getDefaultPaymentMethod

        public java.lang.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 java.lang.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.
      • getEndDate

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

        public java.util.Map<java.lang.String,​java.lang.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.
      • getIterations

        public java.lang.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.
      • getTrial

        public java.lang.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 java.lang.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