Account Information

Information about the account.

APIs.ioEngineeringPlatform

Properties

Name Type Description
billingEmail string The email address to which invoices are sent.
id integer The account's ID.
state string The account's current state: - `FREE` - `PAID` - `EXPIRED_TRIAL` - `OVERDUE` - `SUSPENDED` - `BLOCKED` - `PAYMENT_DISPUTED`
teamId integer The team's ID associated with the account.
salesChannel string 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 object Information about the team's slots.
View JSON Schema on GitHub

JSON Schema

apis-io-engineering-platform-invoicesaccountinfo-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/invoicesAccountInfo",
  "title": "Account Information",
  "type": "object",
  "description": "Information about the account.",
  "properties": {
    "billingEmail": {
      "type": "string",
      "format": "email",
      "description": "The email address to which invoices are sent.",
      "example": "[email protected]"
    },
    "id": {
      "type": "integer",
      "description": "The account's ID.",
      "example": 12345678
    },
    "state": {
      "type": "string",
      "description": "The account's current state:\n- `FREE`\n- `PAID`\n- `EXPIRED_TRIAL`\n- `OVERDUE`\n- `SUSPENDED`\n- `BLOCKED`\n- `PAYMENT_DISPUTED`\n",
      "example": "PAID"
    },
    "teamId": {
      "type": "integer",
      "description": "The team's ID associated with the account.",
      "example": 1234
    },
    "salesChannel": {
      "type": "string",
      "description": "The sales channel from which the account was created:\n- `SELF_SERVE` \u2014 The user purchased the account plan.\n- `SALES_SERVE` \u2014 The account was purchased through the Postman sales team process.\n",
      "enum": [
        "SELF_SERVE",
        "SALES_SERVE"
      ],
      "example": "SELF_SERVE"
    },
    "slots": {
      "type": "object",
      "description": "Information about the team's slots.",
      "properties": {
        "available": {
          "type": "integer",
          "description": "The number of the team's available slots.",
          "example": 8
        },
        "consumed": {
          "type": "integer",
          "description": "The number of currently-billed team members.",
          "example": 2
        },
        "total": {
          "type": "integer",
          "description": "The total number of slots available to the team.",
          "example": 10
        },
        "unbilled": {
          "type": "integer",
          "description": "The number of unbilled slots if [auto-flex billing](https://learning.postman.com/auto-flex-policy/) is available.",
          "example": 0
        }
      }
    }
  }
}