pub struct Invoice {Show 83 fields
pub id: InvoiceId,
pub account_country: Option<String>,
pub account_name: Option<String>,
pub account_tax_ids: Option<Vec<Expandable<TaxId>>>,
pub amount_due: Option<i64>,
pub amount_paid: Option<i64>,
pub amount_remaining: Option<i64>,
pub amount_shipping: Option<i64>,
pub application: Option<Expandable<Application>>,
pub application_fee_amount: Option<i64>,
pub attempt_count: Option<u64>,
pub attempted: Option<bool>,
pub auto_advance: Option<bool>,
pub automatic_tax: Option<AutomaticTax>,
pub billing_reason: Option<InvoiceBillingReason>,
pub charge: Option<Expandable<Charge>>,
pub collection_method: Option<CollectionMethod>,
pub created: Option<Timestamp>,
pub currency: Option<Currency>,
pub custom_fields: Option<Vec<InvoiceSettingCustomField>>,
pub customer: Option<Expandable<Customer>>,
pub customer_address: Option<Address>,
pub customer_email: Option<String>,
pub customer_name: Option<String>,
pub customer_phone: Option<String>,
pub customer_shipping: Option<Shipping>,
pub customer_tax_exempt: Option<InvoiceCustomerTaxExempt>,
pub customer_tax_ids: Option<Vec<InvoicesResourceInvoiceTaxId>>,
pub default_payment_method: Option<Expandable<PaymentMethod>>,
pub default_source: Option<Expandable<PaymentSource>>,
pub default_tax_rates: Option<Vec<TaxRate>>,
pub deleted: bool,
pub description: Option<String>,
pub discount: Option<Discount>,
pub discounts: Option<Vec<Expandable<Discount>>>,
pub due_date: Option<Timestamp>,
pub effective_at: Option<Timestamp>,
pub ending_balance: Option<i64>,
pub footer: Option<String>,
pub from_invoice: Option<InvoicesFromInvoice>,
pub hosted_invoice_url: Option<String>,
pub invoice_pdf: Option<String>,
pub issuer: Option<ConnectAccountReference>,
pub last_finalization_error: Option<Box<ApiErrors>>,
pub latest_revision: Option<Expandable<Invoice>>,
pub lines: Option<List<InvoiceLineItem>>,
pub livemode: Option<bool>,
pub metadata: Option<Metadata>,
pub next_payment_attempt: Option<Timestamp>,
pub number: Option<String>,
pub on_behalf_of: Option<Expandable<Account>>,
pub paid: Option<bool>,
pub paid_out_of_band: Option<bool>,
pub payment_intent: Option<Expandable<PaymentIntent>>,
pub payment_settings: Option<InvoicesPaymentSettings>,
pub period_end: Option<Timestamp>,
pub period_start: Option<Timestamp>,
pub post_payment_credit_notes_amount: Option<i64>,
pub pre_payment_credit_notes_amount: Option<i64>,
pub quote: Option<Expandable<Quote>>,
pub receipt_number: Option<String>,
pub rendering: Option<InvoicesInvoiceRendering>,
pub rendering_options: Option<InvoiceSettingRenderingOptions>,
pub shipping_cost: Option<InvoicesShippingCost>,
pub shipping_details: Option<Shipping>,
pub starting_balance: Option<i64>,
pub statement_descriptor: Option<String>,
pub status: Option<InvoiceStatus>,
pub status_transitions: Option<InvoicesStatusTransitions>,
pub subscription: Option<Expandable<Subscription>>,
pub subscription_details: Option<SubscriptionDetailsData>,
pub subscription_proration_date: Option<Timestamp>,
pub subtotal: Option<i64>,
pub subtotal_excluding_tax: Option<i64>,
pub tax: Option<i64>,
pub test_clock: Option<Expandable<TestHelpersTestClock>>,
pub threshold_reason: Option<InvoiceThresholdReason>,
pub total: Option<i64>,
pub total_discount_amounts: Option<Vec<DiscountsResourceDiscountAmount>>,
pub total_excluding_tax: Option<i64>,
pub total_tax_amounts: Option<Vec<TaxAmount>>,
pub transfer_data: Option<InvoiceTransferData>,
pub webhooks_delivered_at: Option<Timestamp>,
}Expand description
The resource representing a Stripe “Invoice”.
For more details see https://stripe.com/docs/api/invoices/object
Fields§
§id: InvoiceIdUnique identifier for the object.
This property is always present unless the invoice is an upcoming invoice. See Retrieve an upcoming invoice for more details.
account_country: Option<String>The country of the business associated with this invoice, most often the business creating the invoice.
account_name: Option<String>The public name of the business associated with this invoice, most often the business creating the invoice.
account_tax_ids: Option<Vec<Expandable<TaxId>>>The account tax IDs associated with the invoice.
Only editable when the invoice is a draft.
amount_due: Option<i64>Final amount due at this time for this invoice.
If the invoice’s total is smaller than the minimum charge amount, for example, or if there is account credit that can be applied to the invoice, the amount_due may be 0.
If there is a positive starting_balance for the invoice (the customer owes money), the amount_due will also take that into account.
The charge that gets generated for the invoice will be for the amount specified in amount_due.
amount_paid: Option<i64>The amount, in cents (or local equivalent), that was paid.
amount_remaining: Option<i64>The difference between amount_due and amount_paid, in cents (or local equivalent).
amount_shipping: Option<i64>This is the sum of all the shipping amounts.
application: Option<Expandable<Application>>ID of the Connect Application that created the invoice.
application_fee_amount: Option<i64>The fee in cents (or local equivalent) that will be applied to the invoice and transferred to the application owner’s Stripe account when the invoice is paid.
attempt_count: Option<u64>Number of payment attempts made for this invoice, from the perspective of the payment retry schedule.
Any payment attempt counts as the first attempt, and subsequently only automatic retries increment the attempt count. In other words, manual payment attempts after the first attempt do not affect the retry schedule.
attempted: Option<bool>Whether an attempt has been made to pay the invoice.
An invoice is not attempted until 1 hour after the invoice.created webhook, for example, so you might not want to display that invoice as unpaid to your users.
auto_advance: Option<bool>Controls whether Stripe performs automatic collection of the invoice.
If false, the invoice’s state doesn’t automatically advance without an explicit action.
automatic_tax: Option<AutomaticTax>§billing_reason: Option<InvoiceBillingReason>Indicates the reason why the invoice was created.
manual: Unrelated to a subscription, for example, created via the invoice editor.subscription: No longer in use.
Applies to subscriptions from before May 2018 where no distinction was made between updates, cycles, and thresholds. * subscription_create: A new subscription was created. * subscription_cycle: A subscription advanced into a new period. * subscription_threshold: A subscription reached a billing threshold. * subscription_update: A subscription was updated. * upcoming: Reserved for simulated invoices, per the upcoming invoice endpoint.
charge: Option<Expandable<Charge>>ID of the latest charge generated for this invoice, if any.
collection_method: Option<CollectionMethod>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.
created: Option<Timestamp>Time at which the object was created.
Measured in seconds since the Unix epoch.
currency: Option<Currency>Three-letter ISO currency code, in lowercase.
Must be a supported currency.
custom_fields: Option<Vec<InvoiceSettingCustomField>>Custom fields displayed on the invoice.
customer: Option<Expandable<Customer>>The ID of the customer who will be billed.
customer_address: Option<Address>The customer’s address.
Until the invoice is finalized, this field will equal customer.address.
Once the invoice is finalized, this field will no longer be updated.
customer_email: Option<String>The customer’s email.
Until the invoice is finalized, this field will equal customer.email.
Once the invoice is finalized, this field will no longer be updated.
customer_name: Option<String>The customer’s name.
Until the invoice is finalized, this field will equal customer.name.
Once the invoice is finalized, this field will no longer be updated.
customer_phone: Option<String>The customer’s phone number.
Until the invoice is finalized, this field will equal customer.phone.
Once the invoice is finalized, this field will no longer be updated.
customer_shipping: Option<Shipping>The customer’s shipping information.
Until the invoice is finalized, this field will equal customer.shipping.
Once the invoice is finalized, this field will no longer be updated.
customer_tax_exempt: Option<InvoiceCustomerTaxExempt>The customer’s tax exempt status.
Until the invoice is finalized, this field will equal customer.tax_exempt.
Once the invoice is finalized, this field will no longer be updated.
customer_tax_ids: Option<Vec<InvoicesResourceInvoiceTaxId>>The customer’s tax IDs.
Until the invoice is finalized, this field will contain the same tax IDs as customer.tax_ids.
Once the invoice is finalized, this field will no longer be updated.
default_payment_method: Option<Expandable<PaymentMethod>>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.
default_source: Option<Expandable<PaymentSource>>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.
default_tax_rates: Option<Vec<TaxRate>>The tax rates applied to this invoice, if any.
deleted: bool§description: Option<String>An arbitrary string attached to the object.
Often useful for displaying to users. Referenced as ‘memo’ in the Dashboard.
discount: Option<Discount>Describes the current discount applied to this invoice, if there is one.
Not populated if there are multiple discounts.
discounts: Option<Vec<Expandable<Discount>>>The discounts applied to the invoice.
Line item discounts are applied before invoice discounts.
Use expand[]=discounts to expand each discount.
due_date: Option<Timestamp>The date on which payment for this invoice is due.
This value will be null for invoices where collection_method=charge_automatically.
effective_at: Option<Timestamp>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.
ending_balance: Option<i64>Ending customer balance after the invoice is finalized.
Invoices are finalized approximately an hour after successful webhook delivery or when payment collection is attempted for the invoice. If the invoice has not been finalized yet, this will be null.
Footer displayed on the invoice.
from_invoice: Option<InvoicesFromInvoice>Details of the invoice that was cloned.
See the revision documentation for more details.
hosted_invoice_url: Option<String>The URL for the hosted invoice page, which allows customers to view and pay an invoice.
If the invoice has not been finalized yet, this will be null.
invoice_pdf: Option<String>The link to download the PDF for the invoice.
If the invoice has not been finalized yet, this will be null.
issuer: Option<ConnectAccountReference>§last_finalization_error: Option<Box<ApiErrors>>The error encountered during the previous attempt to finalize the invoice.
This field is cleared when the invoice is successfully finalized.
latest_revision: Option<Expandable<Invoice>>The ID of the most recent non-draft revision of this invoice.
lines: Option<List<InvoiceLineItem>>The individual line items that make up the invoice.
lines is sorted as follows: (1) pending invoice items (including prorations) in reverse chronological order, (2) subscription items in reverse chronological order, and (3) invoice items added after invoice creation in chronological order.
livemode: Option<bool>Has the value true if the object exists in live mode or the value false if the object exists in test mode.
metadata: Option<Metadata>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.
next_payment_attempt: Option<Timestamp>The time at which payment will next be attempted.
This value will be null for invoices where collection_method=send_invoice.
number: Option<String>A unique, identifying string that appears on emails sent to the customer for this invoice.
This starts with the customer’s unique invoice_prefix if it is specified.
on_behalf_of: Option<Expandable<Account>>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.
paid: Option<bool>Whether payment was successfully collected for this invoice.
An invoice can be paid (most commonly) with a charge or with credit from the customer’s account balance.
paid_out_of_band: Option<bool>Returns true if the invoice was manually marked paid, returns false if the invoice hasn’t been paid yet or was paid on Stripe.
payment_intent: Option<Expandable<PaymentIntent>>The PaymentIntent associated with this invoice.
The PaymentIntent is generated when the invoice is finalized, and can then be used to pay the invoice. Note that voiding an invoice will cancel the PaymentIntent.
payment_settings: Option<InvoicesPaymentSettings>§period_end: Option<Timestamp>End of the usage period during which invoice items were added to this invoice.
period_start: Option<Timestamp>Start of the usage period during which invoice items were added to this invoice.
post_payment_credit_notes_amount: Option<i64>Total amount of all post-payment credit notes issued for this invoice.
pre_payment_credit_notes_amount: Option<i64>Total amount of all pre-payment credit notes issued for this invoice.
quote: Option<Expandable<Quote>>The quote this invoice was generated from.
receipt_number: Option<String>This is the transaction number that appears on email receipts sent for this invoice.
rendering: Option<InvoicesInvoiceRendering>The rendering-related settings that control how the invoice is displayed on customer-facing surfaces such as PDF and Hosted Invoice Page.
rendering_options: Option<InvoiceSettingRenderingOptions>This is a legacy field that will be removed soon.
For details about rendering_options, refer to rendering instead.
Options for invoice PDF rendering.
shipping_cost: Option<InvoicesShippingCost>The details of the cost of shipping, including the ShippingRate applied on the invoice.
shipping_details: Option<Shipping>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.
starting_balance: Option<i64>Starting customer balance before the invoice is finalized.
If the invoice has not been finalized yet, this will be the current customer balance. For revision invoices, this also includes any customer balance that was applied to the original invoice.
statement_descriptor: Option<String>Extra information about an invoice for the customer’s credit card statement.
status: Option<InvoiceStatus>The status of the invoice, one of draft, open, paid, uncollectible, or void.
status_transitions: Option<InvoicesStatusTransitions>§subscription: Option<Expandable<Subscription>>The subscription that this invoice was prepared for, if any.
subscription_details: Option<SubscriptionDetailsData>Details about the subscription that created this invoice.
subscription_proration_date: Option<Timestamp>Only set for upcoming invoices that preview prorations.
The time used to calculate prorations.
subtotal: Option<i64>Total of all subscriptions, invoice items, and prorations on the invoice before any invoice level discount or exclusive tax is applied.
Item discounts are already incorporated.
subtotal_excluding_tax: Option<i64>The integer amount in cents (or local equivalent) representing the subtotal of the invoice before any invoice level discount or tax is applied.
Item discounts are already incorporated.
tax: Option<i64>The amount of tax on this invoice.
This is the sum of all the tax amounts on this invoice.
test_clock: Option<Expandable<TestHelpersTestClock>>ID of the test clock this invoice belongs to.
threshold_reason: Option<InvoiceThresholdReason>§total: Option<i64>Total after discounts and taxes.
total_discount_amounts: Option<Vec<DiscountsResourceDiscountAmount>>The aggregate amounts calculated per discount across all line items.
total_excluding_tax: Option<i64>The integer amount in cents (or local equivalent) representing the total amount of the invoice including all discounts but excluding all tax.
total_tax_amounts: Option<Vec<TaxAmount>>The aggregate amounts calculated per tax rate for all line items.
transfer_data: Option<InvoiceTransferData>The account (if any) the payment will be attributed to for tax reporting, and where funds from the payment will be transferred to for the invoice.
webhooks_delivered_at: Option<Timestamp>Invoices are automatically paid or sent 1 hour after webhooks are delivered, or until all webhook delivery attempts have been exhausted.
This field tracks the time when webhooks for this invoice were successfully delivered. If the invoice had no webhooks to deliver, this will be set while the invoice is being created.
Implementations§
source§impl Invoice
impl Invoice
sourcepub fn list(
client: &Client,
params: &ListInvoices<'_>
) -> Response<List<Invoice>>
pub fn list( client: &Client, params: &ListInvoices<'_> ) -> Response<List<Invoice>>
You can list all invoices, or list the invoices for a specific customer.
The invoices are returned sorted by creation date, with the most recently created invoices appearing first.
sourcepub fn retrieve(
client: &Client,
id: &InvoiceId,
expand: &[&str]
) -> Response<Invoice>
pub fn retrieve( client: &Client, id: &InvoiceId, expand: &[&str] ) -> Response<Invoice>
Retrieves the invoice with the given ID.
sourcepub fn delete(client: &Client, id: &InvoiceId) -> Response<Deleted<InvoiceId>>
pub fn delete(client: &Client, id: &InvoiceId) -> Response<Deleted<InvoiceId>>
Permanently deletes a one-off invoice draft.
This cannot be undone. Attempts to delete invoices that are no longer in a draft state will fail; once an invoice has been finalized or if an invoice is for a subscription, it must be voided.
source§impl Invoice
impl Invoice
sourcepub fn upcoming(
client: &Client,
params: RetrieveUpcomingInvoice
) -> Response<Invoice>
pub fn upcoming( client: &Client, params: RetrieveUpcomingInvoice ) -> Response<Invoice>
Retrieves the details of an upcoming invoice_id
For more details see https://stripe.com/docs/api#upcoming_invoice.
sourcepub fn finalize(
client: &Client,
invoice_id: &InvoiceId,
params: FinalizeInvoiceParams
) -> Response<Invoice>
pub fn finalize( client: &Client, invoice_id: &InvoiceId, params: FinalizeInvoiceParams ) -> Response<Invoice>
Finalizes an invoice.
For more details see https://stripe.com/docs/api/invoices/finalize..
sourcepub fn pay(client: &Client, invoice_id: &InvoiceId) -> Response<Invoice>
pub fn pay(client: &Client, invoice_id: &InvoiceId) -> Response<Invoice>
Pays an invoice.
For more details see https://stripe.com/docs/api#pay_invoice..
sourcepub fn search(
client: &Client,
params: InvoiceSearchParams<'_>
) -> Response<SearchList<Invoice>>
pub fn search( client: &Client, params: InvoiceSearchParams<'_> ) -> Response<SearchList<Invoice>>
Searches for an invoice.
For more details see https://stripe.com/docs/api/invoices/search.