---
title: "Get a credit grant"
method: GET
path: "/credits/{id}"
tags: ["Credits"]
---

# Get a credit grant

`GET /credits/{id}`

Get a credit grant by ID

## Path parameters

- `id` string, required

## Headers

- `Authorization` string, required
- `sequence-version` '2024-07-30'

## Response `200`

OK

- CreditGrant
  - `id` string, required — Credit Grant ID
  - `sequenceAccountId` string, required — Sequence Account ID
  - `customerId` string, required — The ID of the Customer Credit is granted to
  - `name` string, required — Name of the Credit Grant
  - `creditUnitType` 'CURRENCY' | 'METRIC', required
  - `currency` 'AED' | 'ARS' | 'AUD' | 'BRL' | 'BGN' | 'CAD' | 'CHF' | 'CLP' | 'CNY' | 'COP' | 'CZK' | 'DKK' | 'EGP' | 'EUR' | 'GBP' | 'HKD' | 'ILS' | 'INR' | 'ISK' | 'JPY' | 'KRW' | 'MXN' | 'NOK' | 'NZD' | 'PLN' | 'SAR' | 'SEK' | 'SGD' | 'THB' | 'USD' | 'UYU' | 'ZAR', required
  - `metricId` string — Metric ID (if CreditUnitType is METRIC)
  - `amount` number, required — Amount of Units Granted
  - `costOfCredit` number, required — Cost of Credit Grant, to be Invoiced to the Customer
  - `taxRateId` string — Tax Rate ID for Credit Purchase
  - `effectiveDate` string — First Day Credit Grant can be consumed
  - `expiryDate` string — Last Day Credit Grant can be consumed
  - `createdAt` string, required — The created at
  - `creditNoteId` string — ID of the credit note that created this grant (if applicable)
  - `integrationIds` IntegrationId1[], required — IDs in external integrations
    - `service` 'Amazon_Redshift' | 'GoCardless' | 'Google_BigQuery' | 'Google_Sheets' | 'HubSpot' | 'NetSuite' | 'QuickBooks_Online' | 'Salesforce' | 'Slack' | 'Snowflake' | 'Stripe' | 'Xero' | 'Avalara' | 'Anrok' | 'Attio' | 'Numeral' | 'Rillet' | 'Sphere', required
    - `id` string, required
    - `isPending` boolean, required

## Other responses

- `400` — Bad Request
- `401` — Unauthorized
- `500` — Internal Server Error

---

[API](https://skmtc.net/sequencehq/apis/sequence.md) · [All operations](https://skmtc.net/sequencehq/apis/sequence/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/sequencehq/sequence/versions/cae64b02699f/schema)