---
title: "Credit Status"
method: GET
path: "/api/v1/billing/credit-status"
tags: ["billing"]
---

# Credit Status

`GET /api/v1/billing/credit-status`

## Request

- Base URL: `https://api.nudgelink.co` (the document declares no server; this is the origin it was published from)
- URL: `https://api.nudgelink.co/api/v1/billing/credit-status`
- Auth: HTTP bearer

## Response `200`

Successful Response

- CreditStatusOut: Feeds the dashboard's out-of-credits banner (services/credit_status.py).
  - `is_trial` boolean, required
  - `out_of_credits` boolean, required
  - `credits_balance` integer, required
  - `allowance` integer, required
  - `contacted` integer, required
  - `accepted` integer, required
  - `replied` integer, required
  - `waiting` integer, required
  - `subscribe_bonus_until` string, date-time, nullable, required
  - `subscribe_bonus_credits` integer, required
  - `connect_bonus_until` string, date-time, nullable, required
  - `connect_bonus_credits` integer, required
  - `plan` string, nullable
  - `plan_comped` boolean
  - `pilot_ended` boolean
  - `pilot_running` boolean

---

[API](https://skmtc.dev/nudgelink/apis/nudgelink-api.md) · [All operations](https://skmtc.dev/nudgelink/apis/nudgelink-api/llms.txt) · [OpenAPI document](https://skmtc.dev/nudgelink/apis/nudgelink-api/revisions/baa46e6db986?raw)