Skip to main content
Retrieves a list of credit grants for a customer or environment.

​
Query

query GetCreditGrants($input: GetCreditGrantsInput!) {
  creditGrants(input: $input) {
    edges {
      node {
        id
        amount
        status
        cadence
        expiryDate
        effectiveAt
        description
        createdAt
        customer {
          customerId
          name
        }
      }
    }
    pageInfo {
      hasNextPage
      endCursor
    }
    totalCount
  }
}

​
Parameters

​
input
GetCreditGrantsInput
required
Input parameters for credit grants query

​
Return Type

Returns a CreditGrantConnection with credit grant objects.

​
Common Use Cases

Show customers their credit grant history.
List and manage credit grants in admin interfaces.
Monitor grants approaching expiration.