BillKitCredit notes
Get credit note PDF
Download the credit note as a PDF.
GET/v1/credit_notes/{credit_note_id}/pdf
Parameters
| Parameter | Description |
|---|---|
| credit_note_idstring · pathrequired | Id of the credit note, which starts cn_. |
Errors
| Status | Cause |
|---|---|
| 400 | The request was refused (type: invalid_request_error): a required parameter is missing (parameter_missing), one failed validation (parameter_invalid) or is not one the operation takes (parameter_unknown), and param names it. |
| 401 | No credential, or one that does not authenticate. |
| 402 | The account is suspended (tenant_suspended), or the payment provider refused a charge or refund the call made (type: payment_error, code: payment_refused). |
| 403 | Authenticated, but not allowed: missing scope (insufficient_scope), a key of the wrong mode (mode_mismatch), or a refused origin. Needs the credit_notes:read scope. |
| 404 | No such object in this account and mode. |
| 429 | Rate limited. Retry-After says when to try again. |
| 500 | Something failed on BillKit's side (type: api_error). Retry with the same Idempotency-Key. |
| 501 | The feature is not available on this deployment. |
| 503 | Temporarily unable to serve. reason says whether the request was attempted. |
Other credit notes operations
- List credit notes GET /v1/credit_notes
- Get credit note GET /v1/credit_notes/{credit_note_id}