Struct UpdateInvoice 

pub struct UpdateInvoice { /* private fields */ }

Draft invoices are fully editable. Once an invoice is finalized,. monetary values, as well as collection_method, become uneditable.

If you would like to stop the Stripe Billing engine from automatically finalizing, reattempting payments on,. sending reminders for, or automatically reconciling invoices, pass. auto_advance=false.

Implementations

impl UpdateInvoice

pub fn new(invoice: impl Into<InvoiceId>) -> Self

Construct a new UpdateInvoice.

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

The account tax IDs associated with the invoice. Only editable when the invoice is a draft.

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

A fee in cents (or local equivalent) that will be applied to the invoice and transferred to the application owner’s Stripe account. The request must be made with an OAuth key or the Stripe-Account header in order to take an application fee. For more information, see the application fees documentation.

pub fn auto_advance(self, auto_advance: impl Into<bool>) -> Self

Controls whether Stripe performs automatic collection of the invoice.

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

Settings for automatic tax lookup for this invoice.

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

The time when this invoice should be scheduled to finalize (up to 5 years in the future). The invoice is finalized at this time if it’s still in draft state. To turn off automatic finalization, set auto_advance to false.

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

Either charge_automatically or send_invoice. This field can be updated only on draft invoices.

pub fn custom_fields( self, custom_fields: impl Into<Vec<CustomFieldParams>>, ) -> Self

A list of up to 4 custom fields to be displayed on the invoice. If a value for custom_fields is specified, the list specified will replace the existing custom field list on this invoice. Pass an empty string to remove previously-defined fields.

pub fn days_until_due(self, days_until_due: impl Into<u32>) -> Self

The number of days from which the invoice is created until it is due. Only valid for invoices where collection_method=send_invoice. This field can only be updated on draft invoices.

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

ID of the default payment method for the invoice. It must belong to the customer associated with the invoice. If not set, defaults to the subscription’s default payment method, if any, or to the default payment method in the customer’s invoice settings.

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

ID of the default payment source for the invoice. It must belong to the customer associated with the invoice and be in a chargeable state. If not set, defaults to the subscription’s default source, if any, or to the customer’s default source.

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. Pass an empty string to remove previously-defined tax rates.

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

An arbitrary string attached to the object. Often useful for displaying to users. Referenced as ‘memo’ in the Dashboard.

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

The discounts that will apply to the invoice. Pass an empty string to remove previously-defined discounts.

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

The date on which payment for this invoice is due. Only valid for invoices where collection_method=send_invoice. This field can only be updated on draft invoices.

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

The date when this invoice is in effect. Same as finalized_at unless overwritten. When defined, this value replaces the system-generated ‘Date of issue’ printed on the invoice PDF and receipt.

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

Specifies which fields in the response should be expanded.

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

Footer to be displayed on the invoice.

pub fn issuer(self, issuer: impl Into<UpdateInvoiceIssuer>) -> Self

The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.

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 number(self, number: impl Into<String>) -> Self

Set the number for this invoice. If no number is present then a number will be assigned automatically when the invoice is finalized. In many markets, regulations require invoices to be unique, sequential and / or gapless. You are responsible for ensuring this is true across all your different invoicing systems in the event that you edit the invoice number using our API. If you use only Stripe for your invoices and do not change invoice numbers, Stripe handles this aspect of compliance for you automatically.

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

The account (if any) for which the funds of the invoice payment are intended. If set, the invoice will be presented with the branding and support information of the specified account. See the Invoices with Connect documentation for details.

pub fn payment_settings( self, payment_settings: impl Into<UpdateInvoicePaymentSettings>, ) -> Self

Configuration settings for the PaymentIntent that is generated when the invoice is finalized.

pub fn rendering(self, rendering: impl Into<UpdateInvoiceRendering>) -> Self

The rendering-related settings that control how the invoice is displayed on customer-facing surfaces such as PDF and Hosted Invoice Page.

pub fn shipping_cost( self, shipping_cost: impl Into<UpdateInvoiceShippingCost>, ) -> Self

Settings for the cost of shipping for this invoice.

pub fn shipping_details( self, shipping_details: impl Into<RecipientShippingWithOptionalFieldsAddress>, ) -> Self

Shipping details for the invoice. The Invoice PDF will use the shipping_details value if it is set, otherwise the PDF will render the shipping address from the customer.

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

Extra information about a charge for the customer’s credit card statement. It must contain at least one letter. If not specified and this invoice is part of a subscription, the default statement_descriptor will be set to the first subscription item’s product’s statement_descriptor.

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

If specified, the funds from the invoice will be transferred to the destination and the ID of the resulting transfer will be found on the invoice’s charge. This will be unset if you POST an empty value.

impl UpdateInvoice

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 UpdateInvoice

fn clone(&self) -> UpdateInvoice

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for UpdateInvoice

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

Formats the value using the given formatter.

impl Serialize for UpdateInvoice

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 UpdateInvoice

type Output = Invoice

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.