---
title: "Get User Credits"
method: GET
path: "/payment/credits"
tags: ["PAYMENT"]
---

# Get User Credits

`GET /payment/credits`

Fetches the spent and total credits for a user
:param db: The database session for accessing the database.
:param tenant: The current tenant
:param auth: The authorization token for the request.
:return: UserCreditsResponse.

## Headers

- `x-tenant` string

## Response `200`

Successful Response

- UserCreditsResponse
  - `ok` boolean, required
  - `expired` boolean, required
  - `plan_end_date` string, nullable
  - `total_available_executions` integer, required
  - `total_executions` integer, required
  - `plan_total_executions` integer, required
  - `plan_available_executions` integer, required
  - `used_executions` integer, required
  - `available_grant` integer, required
  - `granted_executions` integer, required
  - `extra_executions` integer, required
  - `current_start_date` string, required
  - `next_refresh_date` string, required
  - `credit_type` string, required
  - `tenure` string, required
  - `cost_per_execution` number, required
  - `total_cost` number, required
  - `free_grant_remaining` boolean, required
  - `downgraded_info` DowngradeInfo
    - `plan_name` string, required
    - `plan_display_name` string, required
    - `current_subscription_end_date` string, required
    - `tenure` string, required
  - `plan_to_edition_map` object, required
  - `current_edition` string, nullable
  - `expiry_projection` string, nullable
  - `feedback_grant_eligible` boolean
  - `feedback_grant_claimed` boolean
  - `feedback_grant_url` string

## Other responses

- `400` — Not supported for public user
- `403` — Not supported for public user
- `422` — Validation Error

---

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