Struct stripe::CreateInvoiceItem [−][src]
The parameters for InvoiceItem::create
.
Fields
amount: Option<i64>
The integer amount in %s 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.
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_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.
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 %s with at most 12 decimal places.
Only one of unit_amount
and unit_amount_decimal
can be set.
Implementations
impl<'a> CreateInvoiceItem<'a>
[src]
pub fn new(customer: CustomerId) -> Self
[src]
Trait Implementations
impl<'a> Clone for CreateInvoiceItem<'a>
[src]
fn clone(&self) -> CreateInvoiceItem<'a>
[src]
pub fn clone_from(&mut self, source: &Self)
1.0.0[src]
impl<'a> Debug for CreateInvoiceItem<'a>
[src]
impl<'a> Serialize for CreateInvoiceItem<'a>
[src]
Auto Trait Implementations
impl<'a> RefUnwindSafe for CreateInvoiceItem<'a>
impl<'a> Send for CreateInvoiceItem<'a>
impl<'a> Sync for CreateInvoiceItem<'a>
impl<'a> Unpin for CreateInvoiceItem<'a>
impl<'a> UnwindSafe for CreateInvoiceItem<'a>
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> 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>,