Postman

Postman Billing API

The billing API from Postman — 2 operation(s) for billing.

GitHub OpenAPI
Business capability
Invoicing & Statement Management BC-4250.30

Operations 2

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /accounts Get my team's billing account · Get accounts #
Ask an LLM
“What billing account details does my team have?”
“Where do I find my billing account ID?”
Tell an agent
Get my team's billing account details.
Show our billing account.
GET /accounts/{accountId}/invoices List a billing account's invoices · List account invoices #
Ask an LLM
“Which invoices are on my billing account?”
“Can I filter a billing account's invoices by their status?”
Tell an agent
List {status} invoices for billing account {accountId}.
Show invoices with status {status} on account {accountId}.

Documentation

📖
Documentation
https://www.postman.com/postman/postman-public-workspace/documentation/i2uqzpp/postman-api

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/postman/refs/heads/main/openapi/postman-billing-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/postman/refs/heads/main/json-schema/postman-invoices-account-info-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/postman/refs/heads/main/json-schema/postman-get-account-invoices-schema.json

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/postman:postman-billing-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

postman-billing-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Postman Billing API
  version: 1.0.0
servers:
- url: https://api.postman.com
  description: https://api.postman.com
- url: https://api.eu.postman.com
  description: https://api.eu.postman.com
tags:
- name: Billing
paths:
  /accounts:
    get:
      operationId: getAccounts
      summary: Get accounts
      description: Gets Postman billing account details for the given team.
      tags:
      - Billing
      parameters:
      - name: x-api-key
        in: header
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/invoicesAccountInfo'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetAccountsRequestUnauthorizedError'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetAccountsRequestInternalServerError'
  /accounts/{accountId}/invoices:
    get:
      operationId: getAccountInvoices
      summary: List account invoices
      description: Gets all invoices for a Postman billing account filtered by the status of the invoice.
      tags:
      - Billing
      parameters:
      - name: accountId
        in: path
        description: The account's ID.
        required: true
        schema:
          $ref: '#/components/schemas/billingAccountId'
      - name: status
        in: query
        description: The account's status.
        required: true
        schema:
          $ref: '#/components/schemas/billingAccountStatus'
      - name: x-api-key
        in: header
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/getAccountInvoices'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetAccountInvoicesRequestUnauthorizedError'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetAccountInvoicesRequestInternalServerError'
components:
  schemas:
    commonErrorTypeTitleDetail:
      type: object
      properties:
        type:
          type: string
          description: The type of error.
        title:
          type: string
          description: A short summary of the problem.
        detail:
          $ref: '#/components/schemas/CommonErrorTypeTitleDetailDetail'
          description: Information about the error.
      title: commonErrorTypeTitleDetail
    GetAccountInvoicesRequestInternalServerError:
      oneOf:
      - $ref: '#/components/schemas/commonErrorTypeTitleDetail'
      - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
      - $ref: '#/components/schemas/commonErrorNameMessage'
      title: GetAccountInvoicesRequestInternalServerError
    invoicesAccountInfo:
      type: object
      properties:
        billingEmail:
          type: string
          format: email
          description: The email address to which invoices are sent.
        id:
          type: integer
          description: The account's ID.
        state:
          type: string
          description: 'The account''s current state:

            - `FREE`

            - `PAID`

            - `EXPIRED_TRIAL`

            - `OVERDUE`

            - `SUSPENDED`

            - `BLOCKED`

            - `PAYMENT_DISPUTED`

            '
        teamId:
          type: integer
          description: The team's ID associated with the account.
        salesChannel:
          $ref: '#/components/schemas/InvoicesAccountInfoSalesChannel'
          description: 'The sales channel from which the account was created:

            - `SELF_SERVE` — The user purchased the account plan.

            - `SALES_SERVE` — The account was purchased through the Postman sales team process.

            '
        slots:
          $ref: '#/components/schemas/invoicesSlots'
      description: Information about the account.
      title: invoicesAccountInfo
    commonErrorNameMessage:
      type: object
      properties:
        error:
          $ref: '#/components/schemas/CommonErrorNameMessageError'
          description: Information about the error.
      title: commonErrorNameMessage
    GetAccountsRequestInternalServerError:
      oneOf:
      - $ref: '#/components/schemas/commonErrorTypeTitleDetail'
      - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
      - $ref: '#/components/schemas/commonErrorNameMessage'
      title: GetAccountsRequestInternalServerError
    billingAccountId:
      type: string
      title: billingAccountId
    GetAccountsRequestUnauthorizedError:
      oneOf:
      - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
      - $ref: '#/components/schemas/commonErrorNameMessage'
      title: GetAccountsRequestUnauthorizedError
    billingAccountStatus:
      type: string
      enum:
      - PAID
      title: billingAccountStatus
    invoiceData:
      type: object
      properties:
        id:
          type: string
          description: The invoice's ID.
        status:
          type: string
          description: The invoice's status.
        issuedAt:
          type: string
          format: date
          description: The date on which the invoice was issued.
        totalAmount:
          $ref: '#/components/schemas/invoicesTotal'
        links:
          $ref: '#/components/schemas/invoicesLinks'
      description: Information about the invoice.
      title: invoiceData
    InvoicesAccountInfoSalesChannel:
      type: string
      enum:
      - SELF_SERVE
      - SALES_SERVE
      description: 'The sales channel from which the account was created:

        - `SELF_SERVE` — The user purchased the account plan.

        - `SALES_SERVE` — The account was purchased through the Postman sales team process.

        '
      title: InvoicesAccountInfoSalesChannel
    invoicesSlots:
      type: object
      properties:
        available:
          type: integer
          description: The number of the team's available slots.
        consumed:
          type: integer
          description: The number of currently-billed team members.
        total:
          type: integer
          description: The total number of slots available to the team.
        unbilled:
          type: integer
          description: The number of unbilled slots if [auto-flex billing](https://learning.postman.com/auto-flex-policy/) is available.
      description: Information about the team's slots.
      title: invoicesSlots
    invoicesTotal:
      type: object
      properties:
        value:
          type: integer
          description: The amount billed.
        currency:
          type: string
          description: The currency of the billed amount. Currently only supports the `USD` value.
      description: Information about the invoice's total billed amount.
      title: invoicesTotal
    CommonErrorTypeTitleDetailStatusType:
      oneOf:
      - type: string
        format: uri-reference
      - type: string
      title: CommonErrorTypeTitleDetailStatusType
    getAccountInvoices:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/invoiceData'
          description: A list of account invoices.
      required:
      - data
      title: getAccountInvoices
    InvoicesLinksWeb:
      type: object
      properties:
        href:
          type: string
          format: url
          description: A URL where you can download the invoice in PDF and view details.
      description: An object containing web-based account references.
      title: InvoicesLinksWeb
    commonErrorTypeTitleDetailStatus:
      type: object
      properties:
        type:
          $ref: '#/components/schemas/CommonErrorTypeTitleDetailStatusType'
        title:
          type: string
          description: A short summary of the problem.
        detail:
          type: string
          description: Information about the error.
        status:
          type: integer
          description: The error's HTTP status code.
      title: commonErrorTypeTitleDetailStatus
    GetAccountInvoicesRequestUnauthorizedError:
      oneOf:
      - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
      - $ref: '#/components/schemas/commonErrorNameMessage'
      title: GetAccountInvoicesRequestUnauthorizedError
    invoicesLinks:
      type: object
      properties:
        web:
          $ref: '#/components/schemas/InvoicesLinksWeb'
          description: An object containing web-based account references.
      description: A [JSON API spec](https://jsonapi.org/format/#document-links) object containing hypermedia links.
      title: invoicesLinks
    CommonErrorTypeTitleDetailDetail:
      oneOf:
      - type: string
      - type: object
        additionalProperties:
          description: Any type
      description: Information about the error.
      title: CommonErrorTypeTitleDetailDetail
    CommonErrorNameMessageError:
      type: object
      properties:
        name:
          type: string
          description: The error name.
        message:
          type: string
          description: The error message.
      description: Information about the error.
      title: CommonErrorNameMessageError
  securitySchemes:
    PostmanApiKey:
      type: apiKey
      in: header
      name: x-api-key
    basicAuth:
      type: http
      scheme: basic
    scimApiKey:
      type: apiKey
      in: header
      name: Authorization
      description: A valid [SCIM API key](https://learning.postman.com/docs/administration/scim-provisioning/scim-provisioning-overview/#generating-scim-api-key) for calls to SCIM endpoints.
x-provenance:
  first_party: true
  method: harvested
  provider_published: true
  source: https://learning.postman.com/api-docs/openapi.json
  harvested: '2026-08-05'
  note: Postman's own OpenAPI 3.1 definition for the Postman API, served by its Fern-hosted API reference. 162 paths, 256 operations, servers api.postman.com and api.eu.postman.com.