Struct stripe::UpdateInvoiceItem

pub struct UpdateInvoiceItem<'a> {

    pub amount: Option<i64>,
    pub description: Option<&'a str>,
    pub discountable: Option<bool>,
    pub discounts: Option<Vec<UpdateInvoiceItemDiscounts>>,
    pub expand: &'a [&'a str],
    pub metadata: Option<Metadata>,
    pub period: Option<Period>,
    pub price: Option<PriceId>,
    pub price_data: Option<InvoiceItemPriceData>,
    pub quantity: Option<u64>,
    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>,
}

The parameters for InvoiceItem::update.

Fields

amount: Option<i64>

The integer amount in cents (or local equivalent) 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.

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. Cannot be set to true for prorations.

discounts: Option<Vec<UpdateInvoiceItemDiscounts>>

The coupons & existing discounts which apply to the invoice item or invoice line item.

Item discounts are applied before invoice discounts. Pass an empty string to remove previously-defined discounts.

expand: &'a [&'a str]

Specifies which fields in the response should be expanded.

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.

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. Pass an empty string to remove previously-defined tax rates.

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. If you want to apply a credit to the customer’s account, pass a negative unit_amount.

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> UpdateInvoiceItem<'a>

pub fn new() -> Self

Trait Implementations

impl<'a> Clone for UpdateInvoiceItem<'a>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for UpdateInvoiceItem<'a>

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

Formats the value using the given formatter.

impl<'a> Default for UpdateInvoiceItem<'a>

fn default() -> UpdateInvoiceItem<'a>

Returns the “default value” for a type.

impl<'a> Serialize for UpdateInvoiceItem<'a>

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

where __S: Serializer,

Serialize this value into the given Serde serializer.