Struct stripe::CreateInvoiceItem

pub struct CreateInvoiceItem<'a> {
    pub amount: Option<i64>,
    pub currency: Currency,
    pub customer: CustomerId,
    pub description: Option<&'a str>,
    pub discountable: Option<bool>,
    pub expand: &'a [&'a str],
    pub invoice: Option<InvoiceId>,
    pub metadata: Option<Metadata>,
    pub period: Option<Period>,
    pub quantity: Option<u64>,
    pub subscription: Option<SubscriptionId>,
    pub tax_rates: Option<Vec<String>>,
    pub unit_amount: Option<i64>,
}

The parameters for InvoiceItem::create.

Fields

amount: Option<i64>

The integer amount in %s of the charge to be applied to the upcoming invoice.

If you want to apply a credit to the customer's account, pass a negative amount.

currency: Currency

Three-letter ISO currency code, in lowercase.

Must be a supported currency.

customer: CustomerId

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

description: Option<&'a str>

An arbitrary string which you can attach to the invoice item.

The description is displayed in the invoice for easy tracking.

discountable: Option<bool>

Controls whether discounts apply to this invoice item.

Defaults to false for prorations or negative invoice items, and true for all other invoice items.

expand: &'a [&'a str]

Specifies which fields in the response should be expanded.

invoice: Option<InvoiceId>

The ID of an existing invoice to add this invoice item to.

When left blank, the invoice item will be added to the next upcoming scheduled invoice. This is useful when adding invoice items in response to an invoice.created webhook. You can only add invoice items to draft invoices.

metadata: Option<Metadata>

A set of key-value pairs that you can attach to an invoice item object.

It can be useful for storing additional information about the invoice item in a structured format.

period: Option<Period>

The period associated with this invoice item.

quantity: Option<u64>

Non-negative integer.

The quantity of units for the invoice item.

subscription: Option<SubscriptionId>

The ID of a subscription to add this invoice item to.

When left blank, the invoice item will be be added to the next upcoming scheduled invoice. When set, scheduled invoices for subscriptions other than the specified subscription will ignore the invoice item. Use this when you want to express that an invoice item has been accrued within the context of a particular subscription.

tax_rates: Option<Vec<String>>

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.

unit_amount: Option<i64>

The integer unit amount in %s of the charge to be applied to the upcoming invoice.

This unit_amount will be multiplied by the quantity to get the full amount. If you want to apply a credit to the customer's account, pass a negative unit_amount.

Methods

impl<'a> CreateInvoiceItem<'a>

pub fn new(currency: Currency, customer: CustomerId) -> Self

Trait Implementations

impl<'a> Clone for CreateInvoiceItem<'a>

fn clone(&self) -> CreateInvoiceItem<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for CreateInvoiceItem<'a>

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

Formats the value using the given formatter.

impl<'a> Serialize for CreateInvoiceItem<'a>

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.