Package com.stripe.param.checkout

Class SessionCreateParams.SubscriptionData

java.lang.Object
com.stripe.param.checkout.SessionCreateParams.SubscriptionData
Enclosing class:
SessionCreateParams
public static class SessionCreateParams.SubscriptionData extends Object
Specifies whether the rate is considered inclusive of taxes or exclusive of taxes. One of inclusive, exclusive, or unspecified.

  • Method Details

    • builder

      public static SessionCreateParams.SubscriptionData.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. To use an application fee percent, the request must be made on behalf of another account, using the Stripe-Account header or an OAuth key. For more information, see the application fees documentation.

    • getBillingCycleAnchor

      public Long getBillingCycleAnchor()
      A future timestamp to anchor the subscription's billing cycle for new subscriptions.

    • getDefaultTaxRates

      public List<String> 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 the customer portal.

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

    • getMetadata

      public Map<String,String> 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.

    • getOnBehalfOf

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

    • getProrationBehavior

      public SessionCreateParams.SubscriptionData.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 SessionCreateParams.SubscriptionData.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 Long getTrialEnd()
      Unix timestamp representing the end of the trial period the customer will get before being charged for the first time. Has to be at least 48 hours in the future.

    • getTrialPeriodDays

      public Long getTrialPeriodDays()
      Integer representing the number of trial period days before the customer is charged for the first time. Has to be at least 1.

    • getTrialSettings

      public SessionCreateParams.SubscriptionData.TrialSettings getTrialSettings()
      Settings related to subscription trials.