---
title: "Return the client's total active credit amount"
method: GET
path: "/credit/total"
tags: ["Credit"]
---

# Return the client's total active credit amount

`GET /credit/total`

## Headers

- `X-Fields` string, mask

## Response `200`

Success

- TotalActiveCredit
  - `autoApply` boolean — Whether credits are automatically being applied to new orders
  - `hasCreditPendingOrder` boolean — If a client has an incomplete order that is using credit, the "total active" will remain at 0 until the order is completed.
  - `totalActive` number — The total active amount of credit available on the client account

## Other responses

- `403` — You have not been granted permission to complete this action. Please contact your account manager to grant the proper permission.

---

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