---
title: "Get a list of credit grants"
method: GET
path: "/api/v1/credits/grants"
tags: ["Credit grants"]
---

# Get a list of credit grants

`GET /api/v1/credits/grants`

Retrieves a paginated list of credit grants for a customer.

## Query parameters

- `after` string, uuid
- `before` string, uuid
- `limit` integer
- `customerId` string, required
- `resourceId` string
- `currencyId` string
- `createdAt` object
  - `gt` string, date-time — Greater than the specified createdAt value
  - `gte` string, date-time — Greater than or equal to the specified createdAt value
  - `lt` string, date-time — Less than the specified createdAt value
  - `lte` string, date-time — Less than or equal to the specified createdAt value

## Headers

- `X-ACCOUNT-ID` string
- `X-ENVIRONMENT-ID` string

## Response `200`

A paginated list of credit grant objects.

- CreditGrantListResponseDto — Response list object
  - `data` object[], required
    - `id` string, required — The unique readable identifier of the credit grant
    - `displayName` string, required — The display name of the credit grant
    - `amount` number, required — The total credits granted
    - `consumedAmount` number, required — The total credits consumed from this grant
    - `grantType` 'PAID' | 'PROMOTIONAL' | 'RECURRING' | 'OVERDRAFT', required — The type of credit grant (PAID, PROMOTIONAL, RECURRING, OVERDRAFT)
    - `sourceType` 'PRICE' | 'PLAN_ENTITLEMENT' | 'ADDON_ENTITLEMENT', nullable, required — The source type of the grant (PRICE, PLAN_ENTITLEMENT, ADDON_ENTITLEMENT)
    - `priority` number, required — The priority of the credit grant (lower number = higher priority)
    - `effectiveAt` string, date-time, required — The date when the credit grant becomes effective
    - `expireAt` string, date-time, nullable, required — The date when the credit grant expires
    - `voidedAt` string, date-time, nullable, required — The date when the credit grant was voided
    - `metadata` object, required — Metadata associated with the entity
    - `cost` object, required — The monetary cost of the credit grant
      - `amount` number, required — The cost amount
      - `currency` string, required — The currency code
    - `comment` string, nullable, required — An optional comment on the credit grant
    - `customerId` string, required — The customer ID this grant belongs to
    - `resourceId` string, nullable, required — The resource ID this grant is scoped to
    - `currencyId` string, required — The currency identifier for this grant
    - `invoiceId` string, nullable, required — The billing invoice ID associated with this grant
    - `latestInvoice` object, nullable, required — The latest invoice details for this grant
      - `billingId` string, required — The billing provider invoice ID
      - `status` 'OPEN' | 'PAID' | 'CANCELED', required — The invoice status
      - `createdAt` string, date-time, required — The invoice creation date
      - `updatedAt` string, date-time, required — The invoice last update date
      - `dueDate` string, date-time, nullable, required — The invoice due date
      - `requiresAction` boolean, required — Whether the invoice requires user action
      - `billingReason` 'MANUAL' | 'OTHER', nullable, required — The billing reason for the invoice
      - `paymentUrl` string, nullable, required — The payment URL for settling the invoice
      - `errorMessage` string, nullable, required — Error message if payment failed
      - `pdfUrl` string, nullable, required — The PDF URL of the invoice
      - `currency` string, nullable, required — The invoice currency
      - `subTotal` number, nullable, required — The subtotal amount before tax
      - `total` number, nullable, required — The total amount including tax
      - `tax` number, nullable, required — The tax amount
    - `syncStates` object[], nullable, required — The synchronization states of the entity with external systems
      - `vendorIdentifier` 'AUTH0' | 'ZUORA' | 'STRIPE' | 'HUBSPOT' | 'AWS_MARKETPLACE' | 'SNOWFLAKE' | 'SALESFORCE' | 'BIG_QUERY' | 'OPEN_FGA' | 'APP_STORE' | 'RECEIVED' | 'PREQUEL' | 'AIRWALLEX' | 'STRIPE_INVOICING', required — The vendor identifier of integration
      - `status` 'PENDING' | 'ERROR' | 'SUCCESS' | 'NO_SYNC_REQUIRED', required — Status of the integration sync
      - `syncedEntityId` string, nullable, required — Synced entity id
    - `paymentCollection` 'NOT_REQUIRED' | 'PROCESSING' | 'FAILED' | 'ACTION_REQUIRED', required — The payment collection status
    - `status` 'PAYMENT_PENDING' | 'ACTIVE' | 'EXPIRED' | 'VOIDED' | 'SCHEDULED', required — The effective status of the credit grant
    - `createdAt` string, date-time, required — Timestamp of when the record was created
    - `updatedAt` string, date-time, required — Timestamp of when the record was last updated
  - `pagination` object, required — Pagination metadata including cursors for navigating through results
    - `next` string, uuid, nullable, required — Cursor for fetching the next page of results, or null if no additional pages exist
    - `prev` string, uuid, nullable, required — Cursor for fetching the previous page of results, or null if at the beginning

## Other responses

- `400` — bad request.
- `401` — User is not authenticated.
- `403` — User is not allowed to access this resource.
- `429` — Too many requests.

---

[API](https://skmtc.net/stiggio/apis/stigg-api.md) · [All operations](https://skmtc.net/stiggio/apis/stigg-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/stiggio/stigg-api/revisions/3e2c8cfcd035/schema)