Struct stripe::InvoiceItem [−][src]
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.
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.
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>
price: Option<Price>
The price of the invoice item.
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.
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
[src]
pub fn list(
client: &Client,
params: ListInvoiceItems<'_>
) -> Response<List<InvoiceItem>>
[src]
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>
[src]
client: &Client,
params: CreateInvoiceItem<'_>
) -> Response<InvoiceItem>
Creates an item to be added to a draft invoice (up to 250 items per 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>
[src]
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>
[src]
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>>
[src]
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
[src]
fn clone(&self) -> InvoiceItem
[src]
pub fn clone_from(&mut self, source: &Self)
1.0.0[src]
impl Debug for InvoiceItem
[src]
impl<'de> Deserialize<'de> for InvoiceItem
[src]
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
__D: Deserializer<'de>,
[src]
__D: Deserializer<'de>,
impl Object for InvoiceItem
[src]
type Id = InvoiceItemId
The canonical id type for this object.
fn id(&self) -> Self::Id
[src]
fn object(&self) -> &'static str
[src]
impl Serialize for InvoiceItem
[src]
Auto Trait Implementations
impl RefUnwindSafe for InvoiceItem
[src]
impl Send for InvoiceItem
[src]
impl Sync for InvoiceItem
[src]
impl Unpin for InvoiceItem
[src]
impl UnwindSafe for InvoiceItem
[src]
Blanket Implementations
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
pub fn borrow_mut(&mut self) -> &mut T
[src]
impl<T> DeserializeOwned for T where
T: for<'de> Deserialize<'de>,
[src]
T: for<'de> Deserialize<'de>,
impl<T> From<T> for T
[src]
impl<T> Instrument for T
[src]
pub fn instrument(self, span: Span) -> Instrumented<Self>
[src]
pub fn in_current_span(self) -> Instrumented<Self>
[src]
impl<T> Instrument for T
[src]
pub fn instrument(self, span: Span) -> Instrumented<Self>
[src]
pub fn in_current_span(self) -> Instrumented<Self>
[src]
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T> Same<T> for T
type Output = T
Should always be Self
impl<T> ToOwned for T where
T: Clone,
[src]
T: Clone,
type Owned = T
The resulting type after obtaining ownership.
pub fn to_owned(&self) -> T
[src]
pub fn clone_into(&self, target: &mut T)
[src]
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,
type Error = <U as TryFrom<T>>::Error
The type returned in the event of a conversion error.
pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>
[src]
impl<V, T> VZip<V> for T where
V: MultiLane<T>,
V: MultiLane<T>,
pub fn vzip(self) -> V
impl<T> WithSubscriber for T
[src]
pub fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
[src]
S: Into<Dispatch>,