API ReferenceBilling

Get accounts

View as Markdown
Gets Postman billing account details for the given team.

Authentication

x-api-keystring
API Key authentication via header
OR
Authorizationstring
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.
OR
AuthorizationBasic

Basic authentication of the form Basic <base64(username:password)>.

Response

Successful Response
billingEmailstringformat: "email"
The email address to which invoices are sent.
idinteger
The account's ID.
statestring

The account’s current state:

  • FREE
  • PAID
  • EXPIRED_TRIAL
  • OVERDUE
  • SUSPENDED
  • BLOCKED
  • PAYMENT_DISPUTED
teamIdinteger
The team's ID associated with the account.
salesChannelenum

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.
slotsobject
Information about the team's slots.

Errors

400
Bad Request Error
401
Unauthorized Error
500
Internal Server Error