Struct InvoiceItem

pub struct InvoiceItem {

    pub amount: i64,
    pub currency: Currency,
    pub customer: Expandable<Customer>,
    pub date: Timestamp,
    pub description: Option<String>,
    pub discountable: bool,
    pub discounts: Option<Vec<Expandable<Discount>>>,
    pub id: InvoiceItemId,
    pub invoice: Option<Expandable<Invoice>>,
    pub livemode: bool,
    pub metadata: Option<HashMap<String, String>>,
    pub parent: Option<BillingBillResourceInvoiceItemParentsInvoiceItemParent>,
    pub period: InvoiceLineItemPeriod,
    pub pricing: Option<BillingBillResourceInvoicingPricingPricing>,
    pub proration: bool,
    pub quantity: u64,
    pub tax_rates: Option<Vec<TaxRate>>,
    pub test_clock: Option<Expandable<TestHelpersTestClock>>,
}

Invoice Items represent the component lines of an invoice. An invoice item is added to an. invoice by creating or updating it with an invoice field, at which point it will be included as an invoice line item within invoice.lines.

Invoice Items can be created before you are ready to actually send the invoice. This can be particularly useful when combined. with a subscription. Sometimes you want to add a charge or credit to a customer, but actually charge. or credit the customer’s card only at the end of a regular billing cycle. This is useful for combining several charges. (to minimize per-transaction fees), or for having Stripe tabulate your usage-based billing totals.

Related guides: Integrate with the Invoicing API, Subscription Invoices.

For more details see <https://stripe.com/docs/api/invoiceitems/object>.

Fields

amount: i64

Amount (in the currency specified) of the invoice item. This should always be equal to unit_amount * quantity.

currency: Currency

Three-letter ISO currency code, in lowercase. Must be a supported currency.

customer: Expandable<Customer>

The ID of the customer who will be billed when this invoice item is billed.

date: Timestamp

Time at which the object was created. Measured in seconds since the Unix epoch.

description: Option<String>

An arbitrary string attached to the object. Often useful for displaying to users.

discountable: bool

If true, discounts will apply to this invoice item. Always false for prorations.

discounts: Option<Vec<Expandable<Discount>>>

The discounts which apply to the invoice item. Item discounts are applied before invoice discounts. Use expand[]=discounts to expand each discount.

id: InvoiceItemId

Unique identifier for the object.

invoice: Option<Expandable<Invoice>>

The ID of the invoice this invoice item belongs to.

livemode: 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<HashMap<String, String>>

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.

parent: Option<BillingBillResourceInvoiceItemParentsInvoiceItemParent>

The parent that generated this invoice

period: InvoiceLineItemPeriod

pricing: Option<BillingBillResourceInvoicingPricingPricing>

The pricing information of the invoice item.

proration: bool

Whether the invoice item was created automatically as a proration adjustment when the customer switched plans.

quantity: u64

Quantity of units for the invoice item. If the invoice item is a proration, the quantity of the subscription that the proration was computed for.

tax_rates: Option<Vec<TaxRate>>

The tax rates which apply to the invoice item. When set, the default_tax_rates on the invoice do not apply to this invoice item.

test_clock: Option<Expandable<TestHelpersTestClock>>

ID of the test clock this invoice item belongs to.

Trait Implementations

impl Clone for InvoiceItem

fn clone(&self) -> InvoiceItem

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for InvoiceItem

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

Formats the value using the given formatter.

impl Deserialize for InvoiceItem

fn begin(out: &mut Option<Self>) -> &mut dyn Visitor

The only correct implementation of this method is:

impl FromValueOpt for InvoiceItem

fn from_value(v: Value) -> Option<Self>

impl Object for InvoiceItem

type Id = InvoiceItemId

The canonical id type for this object.

fn id(&self) -> &Self::Id

The id of the object.

fn into_id(self) -> Self::Id

The owned id of the object.

impl ObjectDeser for InvoiceItem

type Builder = InvoiceItemBuilder