> ## Documentation Index > Fetch the complete documentation index at: https://docs.pnplayer.com/llms.txt > Use this file to discover all available pages before exploring further. # Get billing overview > Returns the active plan, current usage, invoices, usage history, expansion packs and effective limits. Requires the `READ_BILLING` scope. ## OpenAPI ````yaml GET /v1/api/billing openapi: 3.1.0 info: title: PN Player API description: >- Manage videos, captions, playlists, tags, analytics, team members and account settings for your PN Player account. All `/v1/api` endpoints accept either an API key in the `X-Auth-Token` header or a JWT in the `Authorization: Bearer` header. Most endpoints also require the calling user to hold a specific role (scope): `READ_MEDIA`, `UPDATE_MEDIA`, `READ_ANALYTICS`, `READ_BILLING`, `READ_SETTINGS`, `UPDATE_SETTINGS` or `UPDATE_USERS`. The required scope is noted on each endpoint. version: 2.0.0 servers: - url: https://api.pnplayer.com security: - apiKeyAuth: [] - bearerAuth: [] tags: - name: Authentication description: >- Obtain a session token or reset a password. These endpoints do not require authentication. - name: Videos description: Create, list, update and delete videos. - name: Captions description: Upload, download, transcribe and manage caption tracks for a video. - name: Playlists description: Manual and rule-based (dynamic) playlists. - name: Tags description: Account-level tags that can be attached to videos. - name: Analytics description: Playback, engagement and usage metrics. - name: Reports description: Saved analytics report links. - name: Account description: Team members and account-wide streaming and security settings. - name: Profile description: The authenticated user's own profile. - name: API keys description: Long-lived keys for programmatic access. - name: Webhooks description: Configure the HTTPS endpoint that receives signed event notifications. - name: Billing description: Plan, usage, invoices, expansion packs and billing address. - name: Transcription settings description: Per-account key/value settings for automatic transcription. - name: Feature requests description: Submit, upvote and discuss feature requests. - name: Agreements description: Data processing agreement (DPA) and enterprise order form signing. paths: /v1/api/billing: get: tags: - Billing summary: Get billing overview description: >- Returns the active plan, current usage, invoices, usage history, expansion packs and effective limits. Requires the `READ_BILLING` scope. responses: '200': description: Billing overview content: application/json: schema: type: object properties: data: $ref: '#/components/schemas/BillingOverview' '403': $ref: '#/components/responses/Forbidden' components: schemas: BillingOverview: type: object properties: videoCount: type: integer bandwidthUsed: type: number description: MB this month storageUsed: type: number description: MB transcription: type: object properties: minutes: type: number description: Minutes transcribed this month cost: type: number billing: $ref: '#/components/schemas/BillingRecord' plan: $ref: '#/components/schemas/Plan' invoices: type: array items: $ref: '#/components/schemas/Invoice' systemUsage: type: object properties: data: type: array items: $ref: '#/components/schemas/UsagePeriod' totals: $ref: '#/components/schemas/UsageTotals' expansionPacks: type: array items: $ref: '#/components/schemas/AccountExpansionPack' description: Active and requested packs effectiveLimits: type: object properties: storageMb: type: integer description: Plan limit plus active storage packs bandwidthMb: type: integer description: Plan limit plus active bandwidth packs BillingRecord: type: object properties: id: type: integer accountId: type: string planId: type: integer status: type: string enum: - active - past_due - canceled startDate: type: string format: date endDate: type: string format: date cancelAt: type: string canceledAt: type: string createdAt: type: string format: date-time Plan: type: object properties: id: type: integer name: type: string example: Pro priceCents: type: integer currency: type: string example: USD maxUsers: type: integer nullable: true maxStorageMb: type: integer nullable: true maxBandwidthMb: type: integer nullable: true createdAt: type: string format: date-time Invoice: type: object properties: id: type: integer accountId: type: string billingId: type: integer invoiceNumber: type: string example: INV-2026-001 amountCents: type: integer currency: type: string status: type: string enum: - pending - paid - failed - refunded invoiceUrl: type: string format: uri nullable: true dueDate: type: string format: date paidAt: type: string format: date-time nullable: true createdAt: type: string format: date-time UsagePeriod: type: object properties: id: type: integer accountId: type: string startDate: type: string format: date endDate: type: string format: date storageUsed: type: number description: MB bandwidthUsed: type: number description: MB minutesTranscribed: type: number totalPlays: type: number totalWatchTime: type: number UsageTotals: type: object description: Totals across usage periods overlapping the current billing period properties: storageUsed: type: number description: Peak MB bandwidthUsed: type: number description: MB minutesTranscribed: type: number totalPlays: type: number totalWatchTime: type: number AccountExpansionPack: type: object properties: id: type: integer accountId: type: string billingId: type: integer catalogPackId: type: integer nullable: true description: '`null` for custom packs' name: type: string type: type: string enum: - storage - bandwidth addedMb: type: integer priceCents: type: integer currency: type: string status: type: string enum: - requested - active - canceled - expired startDate: type: string format: date endDate: type: string format: date note: type: string nullable: true createdAt: type: string format: date-time Error: type: object required: - message properties: message: type: string responses: Forbidden: description: The caller lacks the required scope content: application/json: schema: $ref: '#/components/schemas/Error' example: message: Forbidden securitySchemes: apiKeyAuth: type: apiKey in: header name: X-Auth-Token description: >- API key created in the dashboard or via `POST /v1/api/api-keys`. Keys are prefixed `pn_` and do not expire until revoked. bearerAuth: type: http scheme: bearer bearerFormat: JWT description: Session token from `POST /auth/token`, valid for 24 hours. ````