Struct CreateCreditNote 

pub struct CreateCreditNote { /* private fields */ }

Issue a credit note to adjust the amount of a finalized invoice. A credit note will first reduce the invoice’s amount_remaining (and amount_due), but not below zero. This amount is indicated by the credit note’s pre_payment_amount. The excess amount is indicated by post_payment_amount, and it can result in any combination of the following:.

• Refunds: create a new refund (using `refund_amount`) or link existing refunds (using `refunds`).
.
• Customer balance credit: credit the customer’s balance (using `credit_amount`) which will be automatically applied to their next invoice when it’s finalized.
.
• Outside of Stripe credit: record the amount that is or will be credited outside of Stripe (using `out_of_band_amount`).
.

The sum of refunds, customer balance credits, and outside of Stripe credits must equal the post_payment_amount.

You may issue multiple credit notes for an invoice. Each credit note may increment the invoice’s pre_payment_credit_notes_amount,. post_payment_credit_notes_amount, or both, depending on the invoice’s amount_remaining at the time of credit note creation.

Implementations

impl CreateCreditNote

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

Construct a new CreateCreditNote.

pub fn amount(self, amount: impl Into<i64>) -> Self

The integer amount in cents (or local equivalent) representing the total amount of the credit note. One of amount, lines, or shipping_cost must be provided.

pub fn credit_amount(self, credit_amount: impl Into<i64>) -> Self

The integer amount in cents (or local equivalent) representing the amount to credit the customer’s balance, which will be automatically applied to their next invoice.

pub fn effective_at(self, effective_at: impl Into<Timestamp>) -> Self

The date when this credit note is in effect. Same as created unless overwritten. When defined, this value replaces the system-generated ‘Date of issue’ printed on the credit note PDF.

pub fn email_type( self, email_type: impl Into<CreateCreditNoteEmailType>, ) -> Self

Type of email to send to the customer, one of credit_note or none and the default is credit_note.

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

Specifies which fields in the response should be expanded.

pub fn lines(self, lines: impl Into<Vec<CreateCreditNoteLines>>) -> Self

Line items that make up the credit note. One of amount, lines, or shipping_cost must be provided.

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

The credit note’s memo appears on the credit note PDF.

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

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.

pub fn out_of_band_amount(self, out_of_band_amount: impl Into<i64>) -> Self

The integer amount in cents (or local equivalent) representing the amount that is credited outside of Stripe.

pub fn reason(self, reason: impl Into<CreditNoteReason>) -> Self

Reason for issuing this credit note, one of duplicate, fraudulent, order_change, or product_unsatisfactory.

pub fn refund_amount(self, refund_amount: impl Into<i64>) -> Self

The integer amount in cents (or local equivalent) representing the amount to refund. If set, a refund will be created for the charge associated with the invoice.

pub fn refunds(self, refunds: impl Into<Vec<CreditNoteRefundParams>>) -> Self

Refunds to link to this credit note.

pub fn shipping_cost( self, shipping_cost: impl Into<CreditNoteShippingCost>, ) -> Self

When shipping_cost contains the shipping_rate from the invoice, the shipping_cost is included in the credit note. One of amount, lines, or shipping_cost must be provided.

impl CreateCreditNote

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 CreateCreditNote

fn clone(&self) -> CreateCreditNote

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CreateCreditNote

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

Formats the value using the given formatter.

impl Serialize for CreateCreditNote

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 CreateCreditNote

type Output = CreditNote

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.