Package com.stripe.param
Class QuoteCreateParams
- java.lang.Object
-
- com.stripe.net.ApiRequestParams
-
- com.stripe.param.QuoteCreateParams
-
public class QuoteCreateParams extends ApiRequestParams
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
QuoteCreateParams.AutomaticTax
static class
QuoteCreateParams.Builder
static class
QuoteCreateParams.CollectionMethod
Add all map key/value pairs to `extraParams` map.static class
QuoteCreateParams.Discount
Add all map key/value pairs to `extraParams` map.static class
QuoteCreateParams.FromQuote
Add all map key/value pairs to `extraParams` map.static class
QuoteCreateParams.InvoiceSettings
Theid
of the quote that will be cloned.static class
QuoteCreateParams.LineItem
Add all map key/value pairs to `extraParams` map.static class
QuoteCreateParams.SubscriptionData
The number of intervals between subscription billings.static class
QuoteCreateParams.TransferData
-
Nested classes/interfaces inherited from class com.stripe.net.ApiRequestParams
ApiRequestParams.EnumParam
-
-
Field Summary
-
Fields inherited from class com.stripe.net.ApiRequestParams
EXTRA_PARAMS_KEY
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static QuoteCreateParams.Builder
builder()
java.lang.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.java.lang.Object
getApplicationFeePercent()
A non-negative decimal between 0 and 100, with at most two decimal places.QuoteCreateParams.AutomaticTax
getAutomaticTax()
Settings for automatic tax lookup for this quote and resulting invoices and subscriptions.QuoteCreateParams.CollectionMethod
getCollectionMethod()
Eithercharge_automatically
, orsend_invoice
.java.lang.String
getCustomer()
The customer for which this quote belongs to.java.lang.Object
getDefaultTaxRates()
The tax rates that will apply to any line item that does not havetax_rates
set.java.lang.String
getDescription()
A description that will be displayed on the quote PDF.java.lang.Object
getDiscounts()
The discounts applied to the quote.java.util.List<java.lang.String>
getExpand()
Specifies which fields in the response should be expanded.java.lang.Long
getExpiresAt()
A future timestamp on which the quote will be canceled if inopen
ordraft
status.java.util.Map<java.lang.String,java.lang.Object>
getExtraParams()
Map of extra parameters for custom features not available in this client library.java.lang.String
getFooter()
A footer that will be displayed on the quote PDF.QuoteCreateParams.FromQuote
getFromQuote()
Clone an existing quote.java.lang.String
getHeader()
A header that will be displayed on the quote PDF.QuoteCreateParams.InvoiceSettings
getInvoiceSettings()
All invoices will be billed using the specified settings.java.util.List<QuoteCreateParams.LineItem>
getLineItems()
A list of line items the customer is being quoted for.java.util.Map<java.lang.String,java.lang.String>
getMetadata()
Set of key-value pairs that you can attach to an object.java.lang.Object
getOnBehalfOf()
The account on behalf of which to charge.QuoteCreateParams.SubscriptionData
getSubscriptionData()
When creating a subscription or subscription schedule, the specified configuration data will be used.java.lang.Object
getTransferData()
The data with which to automatically create a Transfer for each of the invoices.-
Methods inherited from class com.stripe.net.ApiRequestParams
toMap
-
-
-
-
Method Detail
-
builder
public static QuoteCreateParams.Builder builder()
-
getApplicationFeeAmount
public java.lang.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 java.lang.Object 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. 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()
Eithercharge_automatically
, orsend_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. Defaults tocharge_automatically
.
-
getCustomer
public java.lang.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 java.lang.Object getDefaultTaxRates()
The tax rates that will apply to any line item that does not havetax_rates
set.
-
getDescription
public java.lang.String 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 java.lang.Object getDiscounts()
The discounts applied to the quote. You can only set up to one discount.
-
getExpand
public java.util.List<java.lang.String> getExpand()
Specifies which fields in the response should be expanded.
-
getExpiresAt
public java.lang.Long getExpiresAt()
A future timestamp on which the quote will be canceled if inopen
ordraft
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 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.
-
getFooter
public java.lang.String 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 instatus=draft
. When using this parameter, you cannot specify any other parameters except forexpires_at
.
-
getHeader
public java.lang.String 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 java.util.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 java.util.Map<java.lang.String,java.lang.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 tometadata
.
-
getOnBehalfOf
public java.lang.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 ifsubscription_data[effective_date]
is present and in the future, otherwise a subscription is created.
-
getTransferData
public java.lang.Object getTransferData()
The data with which to automatically create a Transfer for each of the invoices.
-
-