Billing corrections and fulfilment
Choose a credit note, refund, subscription change, or order action deliberately.
Credit notes are not refunds
A credit note changes the customer's receivable/accounting balance. A refund returns money through a supported payment or wallet path. Cancelling a subscription changes future billing; cancelling a Direct Debit mandate ends collection authority. Select the action that matches the customer outcome.
| Stage | Public request | Verify |
|---|---|---|
| Preview | POST /v2/credit_notes/preview | Invoice/line eligibility, currency, amount and selected credit method. |
| Issue | POST /v2/credit_notes | Use the reviewed request and a stable idempotency key. |
| Inspect | GET /v2/credit_notes/{id} and /lines | Recorded state and line allocation. |
| Void | POST /v2/credit_notes/{id}/void | Current state allows voiding; reconcile the resulting balance. |
Use the exact schemas in the API reference; do not treat internal eligibility endpoints as public API. A preview does not reserve a financial state forever. Reconcile after a timeout before retrying an issue/refund action.
Amounts and examples
For an eligible GBP 100.00 invoice with no prior credits, a GBP 20.00 credit is 2000 minor units. The resulting balance depends on payments and previous credits; retrieve it instead of calculating from a stale page. A matching GBP 20.00 refund is a separate money movement and must not be issued twice because the credit note already exists.
Subscription changes
Before changing a subscription, inspect its current period, items, usage prices, included allowance, and any schedule. Decide when the change takes effect and review the supported proration/renewal behavior. Do not silently rewrite the price used for already-billed usage. See usage pricing and subscriptions.
Order fulfilment
Use confirmed payment/collection state and the current order record. Verify webhook signatures, deduplicate events, and make fulfilment idempotent using your order identity. A Cart conversion creates a Checkout Session; it is not payment completion. A pending Direct Debit collection is not a settled payment.
Keep invoice, payment, credit-note, refund, order, and event references together for support. Never infer success solely from a redirect, an event's arrival order, or an HTTP timeout.