Struct stripe::CreateInvoice [−][src]
The parameters for Invoice::create
.
Fields
account_tax_ids: Option<Vec<String>>
The account tax IDs associated with the invoice.
Only editable when the invoice is a draft.
application_fee_amount: Option<i64>
A fee in %s that will be applied to the invoice and transferred to the application owner's Stripe account.
The request must be made with an OAuth key or the Stripe-Account header in order to take an application fee. For more information, see the application fees documentation.
auto_advance: Option<bool>
Controls whether Stripe will perform automatic collection of the invoice.
When false
, the invoice's state will not automatically advance without an explicit action.
collection_method: Option<CollectionMethod>
Either charge_automatically
, or send_invoice
.
When charging automatically, Stripe will attempt to pay this invoice using the default source attached to the customer.
When sending an invoice, Stripe will email this invoice to the customer with payment instructions.
Defaults to charge_automatically
.
custom_fields: Option<Vec<CustomField>>
A list of up to 4 custom fields to be displayed on the invoice.
customer: CustomerId
The ID of the customer who will be billed.
days_until_due: Option<u32>
The number of days from when the invoice is created until it is due.
Valid only for invoices where collection_method=send_invoice
.
default_payment_method: Option<&'a str>
ID of the default payment method for the invoice.
It must belong to the customer associated with the invoice. If not set, defaults to the subscription's default payment method, if any, or to the default payment method in the customer's invoice settings.
default_source: Option<&'a str>
ID of the default payment source for the invoice.
It must belong to the customer associated with the invoice and be in a chargeable state. If not set, defaults to the subscription's default source, if any, or to the customer's default source.
default_tax_rates: Option<Vec<String>>
The tax rates that will apply to any line item that does not have tax_rates
set.
description: Option<&'a str>
An arbitrary string attached to the object.
Often useful for displaying to users. Referenced as 'memo' in the Dashboard.
discounts: Option<Vec<CreateInvoiceDiscounts>>
The coupons to redeem into discounts for the invoice.
If not specified, inherits the discount from the invoice's customer. Pass an empty string to avoid inheriting any discounts.
due_date: Option<Timestamp>
The date on which payment for this invoice is due.
Valid only for invoices where collection_method=send_invoice
.
expand: &'a [&'a str]
Specifies which fields in the response should be expanded.
Footer to be displayed on the 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
.
statement_descriptor: Option<&'a str>
Extra information about a charge for the customer's credit card statement.
It must contain at least one letter.
If not specified and this invoice is part of a subscription, the default statement_descriptor
will be set to the first subscription item's product's statement_descriptor
.
subscription: Option<SubscriptionId>
The ID of the subscription to invoice, if any.
If not set, the created invoice will include all pending invoice items for the customer. If set, the created invoice will only include pending invoice items for that subscription and pending invoice items not associated with any subscription. The subscription's billing cycle and regular subscription events won't be affected.
transfer_data: Option<CreateInvoiceTransferData>
If specified, the funds from the invoice will be transferred to the destination and the ID of the resulting transfer will be found on the invoice's charge.
Implementations
impl<'a> CreateInvoice<'a>
[src]
pub fn new(customer: CustomerId) -> Self
[src]
Trait Implementations
impl<'a> Clone for CreateInvoice<'a>
[src]
fn clone(&self) -> CreateInvoice<'a>
[src]
pub fn clone_from(&mut self, source: &Self)
1.0.0[src]
impl<'a> Debug for CreateInvoice<'a>
[src]
impl<'a> Serialize for CreateInvoice<'a>
[src]
Auto Trait Implementations
impl<'a> RefUnwindSafe for CreateInvoice<'a>
[src]
impl<'a> Send for CreateInvoice<'a>
[src]
impl<'a> Sync for CreateInvoice<'a>
[src]
impl<'a> Unpin for CreateInvoice<'a>
[src]
impl<'a> UnwindSafe for CreateInvoice<'a>
[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> 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>,