Package com.stripe.param

Class QuoteCreateParams

java.lang.Object
com.stripe.net.ApiRequestParams
com.stripe.param.QuoteCreateParams
public class QuoteCreateParams extends ApiRequestParams

  • Method Details

    • builder

      public static QuoteCreateParams.Builder builder()

    • getApplicationFeeAmount

      public Object getApplicationFeeAmount()
      The amount of the application fee (if any) that will be requested to be applied to the payment and transferred to the application owner's Stripe account. There cannot be any line items with recurring prices when using this field.

    • 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. There must be at least 1 line item with a recurring price to use this field.

    • getAutomaticTax

      public QuoteCreateParams.AutomaticTax getAutomaticTax()
      Settings for automatic tax lookup for this quote and resulting invoices and subscriptions.

    • getCollectionMethod

      public QuoteCreateParams.CollectionMethod getCollectionMethod()
      Either charge_automatically, or send_invoice. When charging automatically, Stripe will attempt to pay invoices at the end of the subscription cycle or at invoice finalization using the default payment method attached to the subscription or 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.

    • getCustomer

      public String getCustomer()
      The customer for which this quote belongs to. A customer is required before finalizing the quote. Once specified, it cannot be changed.

    • getDefaultTaxRates

      public Object getDefaultTaxRates()
      The tax rates that will apply to any line item that does not have tax_rates set.

    • getDescription

      public Object getDescription()
      A description that will be displayed on the quote PDF. If no value is passed, the default description configured in your quote template settings will be used.

    • getDiscounts

      public Object getDiscounts()
      The discounts applied to the quote. You can only set up to one discount.

    • getExpand

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

    • getExpiresAt

      public Long getExpiresAt()
      A future timestamp on which the quote will be canceled if in open or draft status. Measured in seconds since the Unix epoch. If no value is passed, the default expiration date configured in your quote template settings will be used.

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

    • getFooter

      public Object getFooter()
      A footer that will be displayed on the quote PDF. If no value is passed, the default footer configured in your quote template settings will be used.

    • getFromQuote

      public QuoteCreateParams.FromQuote getFromQuote()
      Clone an existing quote. The new quote will be created in status=draft. When using this parameter, you cannot specify any other parameters except for expires_at.

    • getHeader

      public Object getHeader()
      A header that will be displayed on the quote PDF. If no value is passed, the default header configured in your quote template settings will be used.

    • getInvoiceSettings

      public QuoteCreateParams.InvoiceSettings getInvoiceSettings()
      All invoices will be billed using the specified settings.

    • getLineItems

      public List<QuoteCreateParams.LineItem> getLineItems()
      A list of line items the customer is being quoted for. Each line item includes information about the product, the quantity, and the resulting cost.

    • 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 Object getOnBehalfOf()
      The account on behalf of which to charge.

    • getSubscriptionData

      public QuoteCreateParams.SubscriptionData getSubscriptionData()
      When creating a subscription or subscription schedule, the specified configuration data will be used. There must be at least one line item with a recurring price for a subscription or subscription schedule to be created. A subscription schedule is created if subscription_data[effective_date] is present and in the future, otherwise a subscription is created.

    • getTestClock

      public String getTestClock()
      ID of the test clock to attach to the quote.

    • getTransferData

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