create credit note
This block is part of the stripe group and was last modified in core v15.0.0.
create credit note 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.
- flow
flow - connection required
stripeconnection - invoice id required
valuein_… : must be an
openorpaidinvoice. - amount required
numberIn the smallest currency unit. Cannot exceed what the invoice was for, less anything already credited.
- credit type
valuecredit_balanceapplies it to the next invoice,refundsends the money back too,out_of_bandrecords a settlement made elsewhere. • Suggestions:credit_balancerefundout_of_band - reason
valueduplicate,fraudulent,order_changeorproduct_unsatisfactory. • Suggestions:duplicatefraudulentorder_changeproduct_unsatisfactory - memo
valueA note printed on the credit note the customer sees.
- email customer
booleanHave Stripe email the credit note to the customer.
- meta data
object - idempotency key
valueOptional. Reusing a key makes Stripe replay the first response instead of creating a second object : wire something stable per order, like the order GUID.
- flow
flow - connection
stripeconnection - credit note id
value - number
valueThe human-readable credit note number, for your own bookkeeping.
- status
valueissuedorvoid. - amount
number - currency
value - customer id
value - invoice id
value - pdf url
valueStripe's hosted PDF of the credit note.
- meta data
object - credit note
object - success
condition - error
valueStripe's own message, or a sentinel like MISSING_SESSION_ID for a problem in the wiring.
- error code
valueStripe's machine-readable code, e.g.
card_declined,resource_missing. - decline code
valueWhy the bank refused, e.g.
insufficient_funds. Only set on a declined card.
credit subscription |
credit note |
credit customer |
invoice credit |
goodwill |
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