Struct CreateInvoice 

pub struct CreateInvoice { /* private fields */ }

This endpoint creates a draft invoice for a given customer. The invoice remains a draft until you finalize the invoice, which allows you to pay or send the invoice to your customers.

Implementations

impl CreateInvoice

pub fn new() -> Self

Construct a new CreateInvoice.

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. If false, the invoice’s state doesn’t automatically advance without an explicit action. Defaults to false.

pub fn automatic_tax( self, automatic_tax: impl Into<CreateInvoiceAutomaticTax>, ) -> 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.

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

Either charge_automatically, or send_invoice. When charging automatically, Stripe will attempt to pay this invoice using the default source attached to the customer. When sending an invoice, Stripe will email this invoice to the customer with payment instructions. Defaults to charge_automatically.

pub fn currency(self, currency: impl Into<Currency>) -> Self

The currency to create this invoice in. Defaults to that of customer if not specified.

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.

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

The ID of the customer who will be billed.

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

The number of days from when the invoice is created until it is due. Valid only for invoices where collection_method=send_invoice.

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.

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 coupons and promotion codes to redeem into discounts for the invoice. If not specified, inherits the discount from the invoice’s customer. Pass an empty string to avoid inheriting any discounts.

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

The date on which payment for this invoice is due. Valid only for invoices where collection_method=send_invoice.

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

Revise an existing invoice. The new invoice will be created in status=draft. See the revision documentation for more details.

pub fn issuer(self, issuer: impl Into<CreateInvoiceIssuer>) -> 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<CreateInvoicePaymentSettings>, ) -> Self

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

pub fn pending_invoice_items_behavior( self, pending_invoice_items_behavior: impl Into<CreateInvoicePendingInvoiceItemsBehavior>, ) -> Self

How to handle pending invoice items on invoice creation. Defaults to exclude if the parameter is omitted.

pub fn rendering(self, rendering: impl Into<CreateInvoiceRendering>) -> 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<CreateInvoiceShippingCost>, ) -> 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 subscription(self, subscription: impl Into<String>) -> Self

The ID of the subscription to invoice, if any. If set, the created invoice will only include pending invoice items for that subscription. The subscription’s billing cycle and regular subscription events won’t be affected.

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.

impl CreateInvoice

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 CreateInvoice

fn clone(&self) -> CreateInvoice

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CreateInvoice

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

Formats the value using the given formatter.

impl Default for CreateInvoice

fn default() -> Self

Returns the “default value” for a type.

impl Serialize for CreateInvoice

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 CreateInvoice

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.