Struct PayInvoice 

pub struct PayInvoice { /* private fields */ }

Stripe automatically creates and then attempts to collect payment on invoices for customers on subscriptions according to your subscriptions settings. However, if you’d like to attempt payment on an invoice out of the normal collection schedule or for some other reason, you can do so.

Implementations

impl PayInvoice

pub fn new(invoice: impl Into<InvoiceId>) -> Self

Construct a new PayInvoice.

pub fn expand(self, expand: impl Into<Vec<String>>) -> Self

Specifies which fields in the response should be expanded.

pub fn forgive(self, forgive: impl Into<bool>) -> Self

In cases where the source used to pay the invoice has insufficient funds, passing forgive=true controls whether a charge should be attempted for the full amount available on the source, up to the amount to fully pay the invoice. This effectively forgives the difference between the amount available on the source and the amount due.

Passing forgive=false will fail the charge if the source hasn’t been pre-funded with the right amount. An example for this case is with ACH Credit Transfers and wires: if the amount wired is less than the amount due by a small amount, you might want to forgive the difference. Defaults to false.

pub fn mandate(self, mandate: impl Into<String>) -> Self

ID of the mandate to be used for this invoice. It must correspond to the payment method used to pay the invoice, including the payment_method param or the invoice’s default_payment_method or default_source, if set.

pub fn off_session(self, off_session: impl Into<bool>) -> Self

Indicates if a customer is on or off-session while an invoice payment is attempted. Defaults to true (off-session).

pub fn paid_out_of_band(self, paid_out_of_band: impl Into<bool>) -> Self

Boolean representing whether an invoice is paid outside of Stripe. This will result in no charge being made. Defaults to false.

pub fn payment_method(self, payment_method: impl Into<String>) -> Self

A PaymentMethod to be charged. The PaymentMethod must be the ID of a PaymentMethod belonging to the customer associated with the invoice being paid.

pub fn source(self, source: impl Into<String>) -> Self

A payment source to be charged. The source must be the ID of a source belonging to the customer associated with the invoice being paid.

impl PayInvoice

pub async fn send<C: StripeClient>( &self, client: &C, ) -> Result<<Self as StripeRequest>::Output, C::Err>

Send the request and return the deserialized response.

pub fn send_blocking<C: StripeBlockingClient>( &self, client: &C, ) -> Result<<Self as StripeRequest>::Output, C::Err>

Send the request and return the deserialized response, blocking until completion.

Trait Implementations

impl Clone for PayInvoice

fn clone(&self) -> PayInvoice

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PayInvoice

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

Formats the value using the given formatter.

impl Serialize for PayInvoice

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StripeRequest for PayInvoice

type Output = Invoice

The data returned from the eventual API call.

fn build(&self) -> RequestBuilder

Convert the struct into library-agnostic data that can be used by compatible clients to make API calls.

fn customize(&self) -> CustomizableStripeRequest<Self::Output>

Convert to a builder allowing per-request customization.