Skip to main content
GET
/
api
/
v1
/
customer
/
credit-grants
/
{creditGrantId}
/
ledger-entries
List Credit Ledger Entries
curl --request GET \
  --url https://api.example.com/api/v1/customer/credit-grants/{creditGrantId}/ledger-entries
{
  "data": [
    {
      "creditLedgerEntryId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "creditGrantId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "companyId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "customerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "checkoutId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "orderId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "ticketId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "amount": 123,
      "availableAfter": 123,
      "referenceType": "<string>",
      "referenceId": "<string>",
      "idempotencyKey": "<string>",
      "createdBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "createdAt": "2023-11-07T05:31:56Z"
    }
  ],
  "meta": {
    "limit": 10,
    "page": 1,
    "totalItems": 142,
    "totalPages": 15
  }
}

Path Parameters

​
creditGrantId
string<uuid>
required

Credit grant identifier.

Query Parameters

​
limit
number
default:10

Items per page.

Required range: 1 <= x <= 100
​
page
number
default:1

Page number.

Required range: x >= 1
​
createdAt
string

Created date range.

​
sortBy
enum<string>
default:createdAt

Field to sort by.

Available options:
createdAt,
amount
​
sortOrder
enum<string>
default:desc

Sort direction.

Available options:
asc,
desc
​
fields
string

Comma-separated list of fields to include in the response. Supports dot notation.

Response

OK

​
data
object[]
required
​
meta
object
required

Page-based pagination metadata.