Struct stripe::InvoiceItem

pub struct InvoiceItem {
    pub id: InvoiceItemId,
    pub amount: Option<i64>,
    pub currency: Option<Currency>,
    pub customer: Option<Expandable<Customer>>,
    pub date: Option<Timestamp>,
    pub deleted: bool,
    pub description: Option<String>,
    pub discountable: Option<bool>,
    pub invoice: Option<Expandable<Invoice>>,
    pub livemode: Option<bool>,
    pub metadata: Metadata,
    pub period: Option<Period>,
    pub plan: Option<Plan>,
    pub proration: Option<bool>,
    pub quantity: Option<u64>,
    pub subscription: Option<Expandable<Subscription>>,
    pub subscription_item: Option<String>,
    pub tax_rates: Option<Vec<TaxRate>>,
    pub unified_proration: Option<bool>,
    pub unit_amount: Option<i64>,
    pub unit_amount_decimal: Option<String>,
}

The resource representing a Stripe "InvoiceItem".

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

Fields

id: InvoiceItemId

Unique identifier for the object.

amount: Option<i64>

Amount (in the currency specified) of the invoice item.

This should always be equal to unit_amount * quantity.

currency: Option<Currency>

Three-letter ISO currency code, in lowercase.

Must be a supported currency.

customer: Option<Expandable<Customer>>

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

date: Option<Timestamp>

Time at which the object was created.

Measured in seconds since the Unix epoch.

deleted: bool

description: Option<String>

An arbitrary string attached to the object.

Often useful for displaying to users.

discountable: Option<bool>

If true, discounts will apply to this invoice item.

Always false for prorations.

invoice: Option<Expandable<Invoice>>

The ID of the invoice this invoice item belongs to.

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

period: Option<Period>

plan: Option<Plan>

If the invoice item is a proration, the plan of the subscription that the proration was computed for.

proration: Option<bool>

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

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

subscription: Option<Expandable<Subscription>>

The subscription that this invoice item has been created for, if any.

subscription_item: Option<String>

The subscription item that this invoice item has been created for, if any.

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.

unified_proration: Option<bool>

For prorations this indicates whether Stripe automatically grouped multiple related debit and credit line items into a single combined line item.

unit_amount: Option<i64>

Unit Amount (in the currency specified) of the invoice item.

unit_amount_decimal: Option<String>

Same as unit_amount, but contains a decimal value with at most 12 decimal places.

Implementations

impl InvoiceItem

pub fn list(
    client: &Client,
    params: ListInvoiceItems
) -> Response<List<InvoiceItem>>

Returns a list of your invoice items.

Invoice items are returned sorted by creation date, with the most recently created invoice items appearing first.

pub fn create(
    client: &Client,
    params: CreateInvoiceItem
) -> Response<InvoiceItem>

Creates an item to be added to a draft invoice.

If no invoice is specified, the item will be on the next invoice created for the customer specified.

pub fn retrieve(
    client: &Client,
    id: &InvoiceItemId,
    expand: &[&str]
) -> Response<InvoiceItem>

Retrieves the invoice item with the given ID.

pub fn update(
    client: &Client,
    id: &InvoiceItemId,
    params: UpdateInvoiceItem
) -> Response<InvoiceItem>

Updates the amount or description of an invoice item on an upcoming invoice.

Updating an invoice item is only possible before the invoice it’s attached to is closed.

pub fn delete(
    client: &Client,
    id: &InvoiceItemId
) -> Response<Deleted<InvoiceItemId>>

Deletes an invoice item, removing it from an invoice.

Deleting invoice items is only possible when they’re not attached to invoices, or if it’s attached to a draft invoice.

Trait Implementations

impl Clone for InvoiceItem

fn clone(&self) -> InvoiceItem

Returns a copy 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<'de> Deserialize<'de> for InvoiceItem

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

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 object(&self) -> &'static str

The object's type, typically represented in wire format as the object property.

impl Serialize for InvoiceItem

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

Serialize this value into the given Serde serializer.