pub struct UpdateQuote { /* private fields */ }
Expand description
A quote models prices and services for a customer.
Implementations§
Source§impl UpdateQuote
impl UpdateQuote
Sourcepub fn application_fee_amount(
self,
application_fee_amount: impl Into<i64>,
) -> Self
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.
Sourcepub fn application_fee_percent(
self,
application_fee_percent: impl Into<f64>,
) -> Self
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.
Sourcepub fn automatic_tax(
self,
automatic_tax: impl Into<UpdateQuoteAutomaticTax>,
) -> Self
pub fn automatic_tax( self, automatic_tax: impl Into<UpdateQuoteAutomaticTax>, ) -> Self
Settings for automatic tax lookup for this quote and resulting invoices and subscriptions.
Sourcepub fn collection_method(
self,
collection_method: impl Into<QuoteCollectionMethod>,
) -> Self
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
.
Sourcepub fn customer(self, customer: impl Into<String>) -> Self
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.
Sourcepub fn default_tax_rates(
self,
default_tax_rates: impl Into<Vec<String>>,
) -> Self
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.
Sourcepub fn description(self, description: impl Into<String>) -> Self
pub fn description(self, description: impl Into<String>) -> Self
A description that will be displayed on the quote PDF.
Sourcepub fn discounts(self, discounts: impl Into<Vec<DiscountsDataParam>>) -> Self
pub fn discounts(self, discounts: impl Into<Vec<DiscountsDataParam>>) -> Self
The discounts applied to the quote.
Sourcepub fn expand(self, expand: impl Into<Vec<String>>) -> Self
pub fn expand(self, expand: impl Into<Vec<String>>) -> Self
Specifies which fields in the response should be expanded.
Sourcepub fn expires_at(self, expires_at: impl Into<Timestamp>) -> Self
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.
A footer that will be displayed on the quote PDF.
Sourcepub fn header(self, header: impl Into<String>) -> Self
pub fn header(self, header: impl Into<String>) -> Self
A header that will be displayed on the quote PDF.
Sourcepub fn invoice_settings(
self,
invoice_settings: impl Into<UpdateQuoteInvoiceSettings>,
) -> Self
pub fn invoice_settings( self, invoice_settings: impl Into<UpdateQuoteInvoiceSettings>, ) -> Self
All invoices will be billed using the specified settings.
Sourcepub fn line_items(
self,
line_items: impl Into<Vec<UpdateQuoteLineItems>>,
) -> Self
pub fn line_items( self, line_items: impl Into<Vec<UpdateQuoteLineItems>>, ) -> 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.
Sourcepub fn metadata(self, metadata: impl Into<HashMap<String, String>>) -> Self
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
.
Sourcepub fn on_behalf_of(self, on_behalf_of: impl Into<String>) -> Self
pub fn on_behalf_of(self, on_behalf_of: impl Into<String>) -> Self
The account on behalf of which to charge.
Sourcepub fn subscription_data(
self,
subscription_data: impl Into<UpdateQuoteSubscriptionData>,
) -> Self
pub fn subscription_data( self, subscription_data: impl Into<UpdateQuoteSubscriptionData>, ) -> 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.
Sourcepub fn transfer_data(self, transfer_data: impl Into<TransferDataSpecs>) -> Self
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.
Source§impl UpdateQuote
impl UpdateQuote
Sourcepub async fn send<C: StripeClient>(
&self,
client: &C,
) -> Result<<Self as StripeRequest>::Output, C::Err>
pub async fn send<C: StripeClient>( &self, client: &C, ) -> Result<<Self as StripeRequest>::Output, C::Err>
Send the request and return the deserialized response.
Sourcepub fn send_blocking<C: StripeBlockingClient>(
&self,
client: &C,
) -> Result<<Self as StripeRequest>::Output, C::Err>
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§
Source§impl Clone for UpdateQuote
impl Clone for UpdateQuote
Source§fn clone(&self) -> UpdateQuote
fn clone(&self) -> UpdateQuote
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read more