---
title: "Get the coin credit balance for a company/member in a specific month."
method: GET
path: "/api/v2/organizations/{orgSlug}/coins/stats"
tags: ["Coins"]
---

# Get the coin credit balance for a company/member in a specific month.

`GET /api/v2/organizations/{orgSlug}/coins/stats`

## Request

- Base URL: `https://app.officernd.com`
- URL: `https://app.officernd.com/api/v2/organizations/{orgSlug}/coins/stats`
- Auth: OAuth 2
  - Authorization code: `https://identity.officernd.com/auth/authorize`
  - Client credentials
  - Token URL: `https://identity.officernd.com/auth/token` scopes: `flex.space.coins.read`

Get the coin credit balance for a company/member in a specific month. 
            Returns "monthly" and "once" balances of the coins. 
            You must specify either "member id" or "company id" and "month" in the query of the request. 
            If a member is part of a company, any coins that are assigned to the member will be transferred to the company. 
            Always query for the "company id", if the member is part of a company. 

 Required scopes: `flex.space.coins.read`

## Path parameters

- `orgSlug` string, required

## Query parameters

- `month` string, required
- `company` string
- `member` string
- `$select` string
- `$cursorNext` string
- `$cursorPrev` string
- `$limit` number

## Response `200`

- object
  - `rangeStart` number
  - `rangeEnd` number
  - `cursorNext` string
  - `cursorPrev` string
  - `results` CoinStatsResultDto[]
    - `creditAccount` string: The _id of the credit account.
    - `resourceRates` string[]: An array containing the resource rates for which the set of coins are valid.
    - `resourceTypes` string[]: An array containing the resource types for which the set of coins are valid.
    - `oneOffPlans` string[]: An array containing the one-off plans for which the set of coins are valid.
    - `validFor` 'rates' | 'resourceTypes' | 'oneOffPlans' | 'all': Describes the arrays for which the coins are valid. If they are valid for everything the value here will be set to "all".
    - `member` string: The _id of the member to which the set of coins are associated.
    - `company` string: The _id of the company to which the set of coins are associated.
    - `monthly` CoinSummaryDto
      - `total` number: The total number of monthly coins granted.
      - `used` number: The used number of monthly coins.
      - `remaining` number: The remaining number of monthly coins.
    - `once` CoinSummaryDto
      - `total` number: The total number of monthly coins granted.
      - `used` number: The used number of monthly coins.
      - `remaining` number: The remaining number of monthly coins.

---

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