---
title: "Get addon credit grants"
method: GET
path: "/addons/{id}/creditgrants"
tags: ["Credit Grants"]
---

# Get addon credit grants

`GET /addons/{id}/creditgrants`

Use when listing credits attached to an addon (e.g. included prepaid or promo credits).

## Path parameters

- `id` string, required

## Response `200`

OK

- ListCreditGrantsResponse
  - `items` CreditGrantResponse[]
    - `addon_id` string
    - `cadence` 'ONETIME' | 'RECURRING'
    - `conversion_rate` string — amount in the currency = number of credits * conversion_rate ex if conversion_rate is 1, then 1 USD = 1 credit ex if conversion_rate is 2, then 1 USD = 0.5 credits ex if conversion_rate is 0.5, then 1 USD = 2 credits
    - `created_at` string, date-time
    - `created_by` string
    - `credit_grant_anchor` string, date-time
    - `credits` string
    - `end_date` string, date-time
    - `environment_id` string
    - `expiration_duration` integer
    - `expiration_duration_unit` 'DAY' | 'WEEK' | 'MONTH' | 'YEAR'
    - `expiration_type` 'NEVER' | 'DURATION' | 'BILLING_CYCLE'
    - `id` string
    - `metadata` TypesMetadata
    - `name` string
    - `period` 'DAILY' | 'WEEKLY' | 'MONTHLY' | 'ANNUAL' | 'QUARTERLY' | 'HALF_YEARLY'
    - `period_count` integer
    - `plan_id` string
    - `priority` integer
    - `scope` 'PLAN' | 'SUBSCRIPTION' | 'ADDON'
    - `start_date` string, date-time
    - `status` 'published' | 'deleted' | 'archived'
    - `subscription_id` string
    - `tenant_id` string
    - `topup_conversion_rate` string — topup_conversion_rate is the conversion rate for the topup to the currency ex if topup_conversion_rate is 1, then 1 USD = 1 credit ex if topup_conversion_rate is 2, then 1 USD = 0.5 credits ex if topup_conversion_rate is 0.5, then 1 USD = 2 credits
    - `updated_at` string, date-time
    - `updated_by` string
  - `pagination` TypesPaginationResponse
    - `limit` integer
    - `offset` integer
    - `total` integer

## Other responses

- `400` — Invalid request
- `404` — Resource not found
- `500` — Server error

---

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