Struct CreateQuote 

pub struct CreateQuote { /* private fields */ }

A quote models prices and services for a customer. Default options for header, description, footer, and expires_at can be set in the dashboard via the quote template.

Implementations

impl CreateQuote

pub fn new() -> Self

Construct a new CreateQuote.

pub fn application_fee_amount( self, application_fee_amount: impl Into<i64>, ) -> Self

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.

pub fn application_fee_percent( self, application_fee_percent: impl Into<f64>, ) -> Self

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.

pub fn automatic_tax( self, automatic_tax: impl Into<CreateQuoteAutomaticTax>, ) -> Self

Settings for automatic tax lookup for this quote and resulting invoices and subscriptions.

pub fn collection_method( self, collection_method: impl Into<QuoteCollectionMethod>, ) -> Self

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.

pub fn customer(self, customer: impl Into<String>) -> Self

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

pub fn default_tax_rates( self, default_tax_rates: impl Into<Vec<String>>, ) -> Self

The tax rates that will apply to any line item that does not have tax_rates set.

pub fn description(self, description: impl Into<String>) -> Self

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.

pub fn discounts(self, discounts: impl Into<Vec<DiscountsDataParam>>) -> Self

The discounts applied to the quote.

pub fn expand(self, expand: impl Into<Vec<String>>) -> Self

Specifies which fields in the response should be expanded.

pub fn expires_at(self, expires_at: impl Into<Timestamp>) -> Self

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.

pub fn footer(self, footer: impl Into<String>) -> Self

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.

pub fn from_quote(self, from_quote: impl Into<CreateQuoteFromQuote>) -> Self

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.

pub fn header(self, header: impl Into<String>) -> Self

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.

pub fn invoice_settings( self, invoice_settings: impl Into<CreateQuoteInvoiceSettings>, ) -> Self

All invoices will be billed using the specified settings.

pub fn line_items( self, line_items: impl Into<Vec<CreateQuoteLineItems>>, ) -> Self

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.

pub fn metadata(self, metadata: impl Into<HashMap<String, String>>) -> Self

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.

pub fn on_behalf_of(self, on_behalf_of: impl Into<String>) -> Self

The account on behalf of which to charge.

pub fn subscription_data( self, subscription_data: impl Into<CreateQuoteSubscriptionData>, ) -> Self

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.

pub fn test_clock(self, test_clock: impl Into<String>) -> Self

ID of the test clock to attach to the quote.

pub fn transfer_data(self, transfer_data: impl Into<TransferDataSpecs>) -> Self

The data with which to automatically create a Transfer for each of the invoices.

impl CreateQuote

pub async fn send<C: StripeClient>( &self, client: &C, ) -> Result<<Self as StripeRequest>::Output, C::Err>

Send the request and return the deserialized response.

pub fn send_blocking<C: StripeBlockingClient>( &self, client: &C, ) -> Result<<Self as StripeRequest>::Output, C::Err>

Send the request and return the deserialized response, blocking until completion.

Trait Implementations

impl Clone for CreateQuote

fn clone(&self) -> CreateQuote

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for CreateQuote

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for CreateQuote

fn default() -> Self

Returns the “default value” for a type.

impl Serialize for CreateQuote

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StripeRequest for CreateQuote

type Output = Quote

The data returned from the eventual API call.

fn build(&self) -> RequestBuilder

Convert the struct into library-agnostic data that can be used by compatible clients to make API calls.

fn customize(&self) -> CustomizableStripeRequest<Self::Output>

Convert to a builder allowing per-request customization.