Retrieve your remaining credit balance and credit usage using GET /v3/company/{company}/status.

Company Status

Use this endpoint to check the status of your NextSign account: how many credits you have left, and how many credits you have used and purchased — in total or within a given period.

This is useful for monitoring your balance from your own systems, e.g. to alert you before you run out of credits.

Authorization

All requests to this endpoint require authentication using a Bearer Token.

Use your NextSign API key as the bearer token for this endpoint. You create API keys under Dashboard → API keys.

Endpoint

GET https://api.nextsign.dk/v3/company/{company}/status

Path Parameters

Parameter	Type	Description
`company`	`string`	Your company identifier

Query Parameters

Parameter	Type	Description
`from`	`string`	Optional. ISO 8601 date. Only count usage on or after this date
`to`	`string`	Optional. ISO 8601 date. Only count usage on or before this date

from / to only affect the usage numbers (used, added, usedByItem). remaining is always your current balance.

Example Request

cURL

curl --location 'https://api.nextsign.dk/v3/company/{company}/status?from=2026-01-01' \
  -H 'Authorization: Bearer YOUR_API_KEY'

Example Response

200 OK

{
  "company": {
    "id": "6576e19662ec13c4faa7de7b",
    "name": "Example ApS",
    "state": "active"
  },
  "credits": {
    "remaining": 42,
    "used": 158,
    "added": 200,
    "usedByItem": {
      "signing": 130,
      "form-submission": 20,
      "phone-recipient": 8
    }
  },
  "period": {
    "from": "2026-01-01",
    "to": null
  }
}

Response Fields

Field	Type	Description
`company.id`	`string`	Company identifier
`company.name`	`string`	Company name
`company.state`	`string`	Account state: `active` or `disabled`
`credits.remaining`	`number`	Credits currently left on the account
`credits.used`	`number`	Credits spent (within the period, if one is given)
`credits.added`	`number`	Credits added — purchases, trial credits, refunds, etc. (within the period, if one is given)
`credits.usedByItem`	`object`	Credits spent per item type, e.g. `signing`, `form-submission`, `phone-recipient`, `eboks-recipient`
`period`	`object`	Echo of the `from` / `to` filter. Only present when a filter is given

Common Error Responses

Invalid date filter:

400 Bad Request

{
  "error": "'from' and 'to' must be valid dates (ISO 8601)"
}