InvoicePayment

Struct InvoicePayment 

Source
pub struct InvoicePayment {
    pub amount_paid: Option<i64>,
    pub amount_requested: i64,
    pub created: Timestamp,
    pub currency: Currency,
    pub id: InvoicePaymentId,
    pub invoice: Expandable<Invoice>,
    pub is_default: bool,
    pub livemode: bool,
    pub payment: InvoicesPaymentsInvoicePaymentAssociatedPayment,
    pub status: String,
    pub status_transitions: InvoicesPaymentsInvoicePaymentStatusTransitions,
}
Expand description

Invoice Payments represent payments made against invoices. Invoice Payments can be accessed in two ways: 1. By expanding the payments field on the Invoice resource. 2. By using the Invoice Payment retrieve and list endpoints.

Invoice Payments include the mapping between payment objects, such as Payment Intent, and Invoices. This resource and its endpoints allows you to easily track if a payment is associated with a specific invoice and. monitor the allocation details of the payments.

Fields§

§amount_paid: Option<i64>

Amount that was actually paid for this invoice, in cents (or local equivalent). This field is null until the payment is paid. This amount can be less than the amount_requested if the PaymentIntent’s amount_received is not sufficient to pay all of the invoices that it is attached to.

§amount_requested: i64

Amount intended to be paid toward this invoice, in cents (or local equivalent)

§created: Timestamp

Time at which the object was created. Measured in seconds since the Unix epoch.

§currency: Currency

Three-letter ISO currency code, in lowercase. Must be a supported currency.

§id: InvoicePaymentId

Unique identifier for the object.

§invoice: Expandable<Invoice>

The invoice that was paid.

§is_default: bool

Stripe automatically creates a default InvoicePayment when the invoice is finalized, and keeps it synchronized with the invoice’s amount_remaining. The PaymentIntent associated with the default payment can’t be edited or canceled directly.

§livemode: bool

Has the value true if the object exists in live mode or the value false if the object exists in test mode.

§payment: InvoicesPaymentsInvoicePaymentAssociatedPayment§status: String

The status of the payment, one of open, paid, or canceled.

§status_transitions: InvoicesPaymentsInvoicePaymentStatusTransitions

Trait Implementations§

Source§

impl Clone for InvoicePayment

Source§

fn clone(&self) -> InvoicePayment

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for InvoicePayment

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Deserialize for InvoicePayment

Source§

fn begin(out: &mut Option<Self>) -> &mut dyn Visitor

The only correct implementation of this method is: Read more
Source§

impl FromValueOpt for InvoicePayment

Source§

impl Object for InvoicePayment

Source§

type Id = InvoicePaymentId

The canonical id type for this object.
Source§

fn id(&self) -> &Self::Id

The id of the object.
Source§

fn into_id(self) -> Self::Id

The owned id of the object.
Source§

impl ObjectDeser for InvoicePayment

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.