Struct CreateInvoiceItem

pub struct CreateInvoiceItem<'a> {

    pub amount: Option<i64>,
    pub currency: Option<Currency>,
    pub customer: CustomerId,
    pub description: Option<&'a str>,
    pub discountable: Option<bool>,
    pub discounts: Option<Vec<CreateInvoiceItemDiscounts>>,
    pub expand: &'a [&'a str],
    pub invoice: Option<InvoiceId>,
    pub metadata: Option<Metadata>,
    pub period: Option<Period>,
    pub price: Option<PriceId>,
    pub price_data: Option<InvoiceItemPriceData>,
    pub quantity: Option<u64>,
    pub subscription: Option<SubscriptionId>,
    pub tax_behavior: Option<InvoiceItemTaxBehavior>,
    pub tax_code: Option<String>,
    pub tax_rates: Option<Vec<String>>,
    pub unit_amount: Option<i64>,
    pub unit_amount_decimal: Option<&'a str>,
}

Available on crate feature billing only.

The parameters for InvoiceItem::create.

Fields

amount: Option<i64>

The integer amount in cents (or local equivalent) of the charge to be applied to the upcoming invoice.

Passing in a negative amount will reduce the amount_due on the invoice.

currency: Option<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.

discounts: Option<Vec<CreateInvoiceItemDiscounts>>

The coupons to redeem into discounts for the invoice item or invoice line item.

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 and there is a maximum of 250 items per invoice.

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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to metadata.

period: Option<Period>

The period associated with this invoice item.

When set to different values, the period will be rendered on the invoice. If you have Stripe Revenue Recognition enabled, the period will be used to recognize and defer revenue. See the Revenue Recognition documentation for details.

price: Option<PriceId>

The ID of the price object.

price_data: Option<InvoiceItemPriceData>

Data used to generate a new Price object inline.

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_behavior: Option<InvoiceItemTaxBehavior>

Only required if a default tax behavior was not provided in the Stripe Tax settings.

Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of inclusive, exclusive, or unspecified. Once specified as either inclusive or exclusive, it cannot be changed.

tax_code: Option<String>

A tax code ID.

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 cents (or local equivalent) of the charge to be applied to the upcoming invoice.

This unit_amount will be multiplied by the quantity to get the full amount. Passing in a negative unit_amount will reduce the amount_due on the invoice.

unit_amount_decimal: Option<&'a str>

Same as unit_amount, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places.

Only one of unit_amount and unit_amount_decimal can be set.

Implementations

impl<'a> CreateInvoiceItem<'a>

pub fn new(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.