Skip to content

Nextvisit API (1.0.0)

API for the Nextvisit Clinical Documentation platform for developers

Download OpenAPI description
openapi.json
openapi.yaml
Overview
Nextvisit Support
hello@nextvisit.ai
License
Proprietary
Terms of Service
Languages
Servers
Mock server
https://developers.nextvisit.app/_mock/openapi
Production API
https://nextvisit.app/api
Beta API
https://ea.nextvisit.app/api

Tokens

User token management endpoints for secure access to the Nextvisit platform. Includes login, logout, and token management operations.

Operations

Users

User account management including profile updates, permission settings, role assignments, and practice affiliations.

Operations

Progress Notes

Clinical progress note management including creating, updating, retrieving, and signing notes with associated transcriptions and analyses.

Operations

Billing

Billing and subscription management including plans, usage tracking, and cost estimates.

Operations

List available billing plans

Request

Returns a list of all visible billing plans with their pricing and features

Security
bearerAuth
curl -i -X GET \
  https://developers.nextvisit.app/_mock/openapi/v1/billing/plans \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

List of available billing plans

Bodyapplication/json
plansArray of objects(BillingPlan)
Response
application/json
{
  "plans": [
    { … },
    { … },
    { … }
  ]
}

Get billing cost estimate

Request

Returns an estimate of the current billing costs based on the number of users in the team

Security
bearerAuth
curl -i -X GET \
  https://developers.nextvisit.app/_mock/openapi/v1/billing/estimate \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Billing cost estimate

Bodyapplication/json
usersintegerrequired

Total number of users in the team and child teams

Example: 5
totalnumberrequired

Total estimated cost

Example: 995
total_formattedstringrequired

Formatted total cost with currency symbol

Example: "$995.00"
renewal_datestringrequired

Next billing renewal date

Example: "February 16th, 2026"
Response
application/json
{
  "users": 5,
  "total": 995,
  "total_formatted": "$995.00",
  "renewal_date": "February 16th, 2026"
}

Get billing usage statistics

Request

Returns usage statistics for the current billing period including encounters, peer reviews, and documents

Security
bearerAuth
Path
modulestringrequired

The billing module to get usage for (e.g., 'notes')

Example: notes
curl -i -X GET \
  https://developers.nextvisit.app/_mock/openapi/v1/billing/usage/notes \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Usage statistics for the current billing period

Bodyapplication/json
planobjectrequired

Current subscription plan details

plan.​namestring

Name of the subscribed plan

Example: "pro"
plan.​statusstring

Current subscription status

Enum"active""past_due""canceled""incomplete""incomplete_expired""trialing""paused"
Example: "active"
plan.​ends_atstring or null(date)

Date when the subscription ends (if canceled)

Example: null
plan.​activeboolean

Whether the subscription is currently active

Example: true
plan.​past_dueboolean

Whether the subscription has past due payments

Example: false
plan.​trialobject
usageobjectrequired

Usage statistics for the current billing period

usage.​usednumber

Total usage count (weighted sum of all items)

Example: 125
usage.​peer_reviewsstring

Weighted count of peer reviews (0.25 per review)

Example: "25.00"
usage.​encountersstring

Count of encounters (1.0 per encounter)

Example: "75.00"
usage.​documentsstring

Weighted count of documents (0.5 per document)

Example: "25.00"
usage.​period_startstring

Start date of the current billing period

Example: "Jan 1st, 2026"
usage.​period_endstring

End date of the current billing period

Example: "Jan 31st, 2026"
usage.​resets_atstring(date)

Date when usage resets

Example: "2026-01-31"
usage.​limitinteger

Maximum allowed usage for the current plan

Example: 1000
usage.​updatedstring

Timestamp when usage was last calculated

Example: "Jan 16 2026 10:30 AM"
Response
application/json
{
  "plan": {
    "name": "pro",
    "status": "active",
    "ends_at": null,
    "active": true,
    "past_due": false,
    "trial": { … }
  },
  "usage": {
    "used": 125,
    "peer_reviews": "25.00",
    "encounters": "75.00",
    "documents": "25.00",
    "period_start": "Jan 1st, 2026",
    "period_end": "Jan 31st, 2026",
    "resets_at": "2026-01-31",
    "limit": 1000,
    "updated": "Jan 16 2026 10:30 AM"
  }
}

Transcription

Audio transcription services including file upload transcription and temporary API tokens for client-side transcription.

Operations

Patients

Patient management including creating, updating, retrieving, and searching patient records within your team.

Operations