create credit note

This block is part of the stripe group and was last modified in core v15.0.0.

create credit note stripeconnection v15.0.0

Credits a customer against an invoice : the accounting way to give a subscriber a month back without refunding their card. credit_balance (the default) puts the amount on their Stripe balance so it comes off their next invoice; refund also sends the money back; out_of_band just records that you settled it elsewhere. The invoice id comes off get subscription as latest invoice id, or off list invoices.

In pins 9 + flow

flow
connection stripeconnection required
invoice id value required
in_… : must be an open or paid invoice.
amount number required
In the smallest currency unit. Cannot exceed what the invoice was for, less anything already credited.
credit type value
credit_balance applies it to the next invoice, refund sends the money back too, out_of_band records a settlement made elsewhere. • Suggestions: credit_balance refund out_of_band
Default credit_balance
reason value
duplicate, fraudulent, order_change or product_unsatisfactory. • Suggestions: duplicate fraudulent order_change product_unsatisfactory
memo value
A note printed on the credit note the customer sees.
email customer boolean
Have Stripe email the credit note to the customer.
meta data object
idempotency key value
Optional. Reusing a key makes Stripe replay the first response instead of creating a second object : wire something stable per order, like the order GUID.

Out pins 15 + flow

flow
connection stripeconnection
credit note id value
number value
The human-readable credit note number, for your own bookkeeping.
status value
issued or void.
amount number
currency value
customer id value
invoice id value
pdf url value
Stripe's hosted PDF of the credit note.
meta data object
credit note object
success condition
error value
Stripe's own message, or a sentinel like MISSING_SESSION_ID for a problem in the wiring.
error code value
Stripe's machine-readable code, e.g. card_declined, resource_missing.
decline code value
Why the bank refused, e.g. insufficient_funds. Only set on a declined card.

credit subscription

credit note

credit customer

invoice credit

goodwill

A finalised invoice is an accounting record and is never edited: a mistake is corrected by issuing a credit note against it. create credit note takes the invoice id and the amount to credit, and hands back its own numbered document with a PDF link. Use this rather than a refund when the invoice was wrong; use a refund when the invoice was right and the money is going back.

Version history

Introduced in v15.0.0.

Service documentation

External API reference This block wraps a third-party service. Click here for the service's own documentation of the underlying endpoint.

Back to stripe Return to the main group to view all sub-groups Back to credits Return to the group to view all blocks within this group