Package com.stripe.param

Class SubscriptionScheduleCreateParams.DefaultSettings

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

  • Method Details

    • builder

      public static SubscriptionScheduleCreateParams.DefaultSettings.Builder builder()

    • 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.DefaultSettings.AutomaticTax getAutomaticTax()
      Default settings for automatic tax computation.

    • getBillingCycleAnchor

      public SubscriptionScheduleCreateParams.DefaultSettings.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.DefaultSettings.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.

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

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

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

    • getOnBehalfOf

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

    • getTransferData

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