---
title: "Get credits"
method: GET
path: "/public/v1/credits"
tags: ["Credit"]
---

# Get credits

`GET /public/v1/credits`

List store credits held by your customers, newest first (by creation datetime, then id). A
credit is an amount a customer can apply toward what they owe; each row carries its live
computed `status` and `remaining_balance`.

Only credits belonging to your company are returned; soft-deleted credits are excluded. Filter
by customer (`company_ids`), by the invoices a credit has been applied to (`invoice_ids`), by
`amount` range, by `source`, `status`, `credit_number`, or the creation/last-modified windows.
All filters below are combined with AND — a credit must match every filter you send.

This endpoint returns eventually consistent data: a credit you just created, updated, canceled,
or deleted (and any change to its `status`/`remaining_balance`) can take up to 1 second to be
reflected here.

Required permission: `credits_permissions_view`. Only credits the authenticated user can access
under their team restrictions are returned.

## Query parameters

- `ids` string[]
- `amount` string
- `company_ids` string[]
- `credit_number` string
- `invoice_ids` string[]
- `owner_ids` string[]
- `inserted_datetime` string
- `page` string
- `source` 'INVOICE_PAYMENT' | 'QB_CREDIT_MEMO' | 'QB_PAYMENT' | 'RETURN' | 'USER'
- `status` 'ACTIVE' | 'CANCELED' | 'REDEEMED'
- `updated_datetime` string

## Response `200`

A list of credits

## Other responses

- `400` — Invalid parameters
- `401` — Missing or invalid API token
- `403` — The API token lacks the required permission

---

[API](https://skmtc.dev/distru/apis/distru-api.md) · [All operations](https://skmtc.dev/distru/apis/distru-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/distru/distru-api/revisions/eb775b7b6ee0/schema)
