APIs.io Engineering Platform Billing API

openapi: 3.0.0
info:
  version: "1.0.0"
  x-release: v4
  title: APIs.io Engineering Platform Amazon API Gateway 2014 11 13 Billing API
  description: <fullname>Amazon API Gateway</fullname> <p>Amazon API Gateway helps developers deliver robust, secure, and scalable mobile and web application back ends. API Gateway allows developers to securely connect mobile and web applications to APIs that run on AWS Lambda, Amazon EC2, or other publicly addressable web services that are hosted outside of AWS.</p>
  x-logo:
    url: https://api.apis.guru/v2/cache/logo/https_twitter.com_awscloud_profile_image.png
    backgroundColor: '#FFFFFF'
  termsOfService: https://aws.amazon.com/service-terms/
  contact:
    name: Mike Ralphson
    email: mike.ralphson@gmail.com
    url: https://github.com/mermade/aws2openapi
    x-twitter: PermittedSoc
  license:
    name: Apache 2.0 License
    url: http://www.apache.org/licenses/
  x-providerName: amazonaws.com
  x-serviceName: apigateway
  x-origin:
  - contentType: application/json
    url: https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/apigateway-2015-07-09.normal.json
    converter:
      url: https://github.com/mermade/aws2openapi
    x-apisguru-driver: external
  x-apiClientRegistration:
    url: https://portal.aws.amazon.com/gp/aws/developer/registration/index.html?nc2=h_ct
  x-apisguru-categories:
  - cloud
  x-preferred: true
servers:
- url: http://apigateway.{region}.amazonaws.com
  variables:
    region:
      description: The AWS region
      enum:
      - us-east-1
      - us-east-2
      - us-west-1
      - us-west-2
      - us-gov-west-1
      - us-gov-east-1
      - ca-central-1
      - eu-north-1
      - eu-west-1
      - eu-west-2
      - eu-west-3
      - eu-central-1
      - eu-south-1
      - af-south-1
      - ap-northeast-1
      - ap-northeast-2
      - ap-northeast-3
      - ap-southeast-1
      - ap-southeast-2
      - ap-east-1
      - ap-south-1
      - sa-east-1
      - me-south-1
      default: us-east-1
  description: The Amazon API Gateway multi-region endpoint
- url: https://apigateway.{region}.amazonaws.com
  variables:
    region:
      description: The AWS region
      enum:
      - us-east-1
      - us-east-2
      - us-west-1
      - us-west-2
      - us-gov-west-1
      - us-gov-east-1
      - ca-central-1
      - eu-north-1
      - eu-west-1
      - eu-west-2
      - eu-west-3
      - eu-central-1
      - eu-south-1
      - af-south-1
      - ap-northeast-1
      - ap-northeast-2
      - ap-northeast-3
      - ap-southeast-1
      - ap-southeast-2
      - ap-east-1
      - ap-south-1
      - sa-east-1
      - me-south-1
      default: us-east-1
  description: The Amazon API Gateway multi-region endpoint
- url: http://apigateway.{region}.amazonaws.com.cn
  variables:
    region:
      description: The AWS region
      enum:
      - cn-north-1
      - cn-northwest-1
      default: cn-north-1
  description: The Amazon API Gateway endpoint for China (Beijing) and China (Ningxia)
- url: https://apigateway.{region}.amazonaws.com.cn
  variables:
    region:
      description: The AWS region
      enum:
      - cn-north-1
      - cn-northwest-1
      default: cn-north-1
  description: The Amazon API Gateway endpoint for China (Beijing) and China (Ningxia)
security:
- hmac: []
tags:
- name: Billing
  description: Monitor charges and usage from Actions and Packages.
paths:
  /enterprises/{enterprise}/settings/billing/advanced-security:
    get:
      summary: APIs.io Engineering Platform Get GitHub Advanced Security active committers for an enterprise
      description: 'Gets the GitHub Advanced Security active committers for an enterprise per repository.


        Each distinct user login across all repositories is counted as a single Advanced Security seat, so the `total_advanced_security_committers` is not the sum of active_users for each repository.


        The total number of repositories with committer information is tracked by the `total_count` field.'
      tags:
      - Billing
      operationId: billing/get-github-advanced-security-billing-ghe
      externalDocs:
        description: API method documentation
        url: https://docs.github.com/enterprise-server@3.9/rest/enterprise-admin/billing#get-github-advanced-security-active-committers-for-an-enterprise
      parameters:
      - $ref: '#/components/parameters/enterprise'
      - $ref: '#/components/parameters/per-page'
      - $ref: '#/components/parameters/page'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/advanced-security-active-committers'
              examples:
                default:
                  $ref: '#/components/examples/advanced-security-active-committers'
        '403':
          $ref: '#/components/responses/code_scanning_forbidden_read'
      x-github:
        githubCloudOnly: true
        enabledForGitHubApps: false
        category: enterprise-admin
        subcategory: billing
  /orgs/{org}/settings/billing/advanced-security:
    get:
      summary: APIs.io Engineering Platform Get GitHub Advanced Security active committers for an organization
      description: 'Gets the GitHub Advanced Security active committers for an organization per repository.


        Each distinct user login across all repositories is counted as a single Advanced Security seat, so the `total_advanced_security_committers` is not the sum of advanced_security_committers for each repository.


        If this organization defers to an enterprise for billing, the `total_advanced_security_committers` returned from the organization API may include some users that are in more than one organization, so they will only consume a single Advanced Security seat at the enterprise level.


        The total number of repositories with committer information is tracked by the `total_count` field.'
      tags:
      - Billing
      operationId: billing/get-github-advanced-security-billing-org
      externalDocs:
        description: API method documentation
        url: https://docs.github.com/enterprise-server@3.9/rest/billing/billing#get-github-advanced-security-active-committers-for-an-organization
      parameters:
      - $ref: '#/components/parameters/org'
      - $ref: '#/components/parameters/per-page'
      - $ref: '#/components/parameters/page'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/advanced-security-active-committers'
              examples:
                default:
                  $ref: '#/components/examples/advanced-security-active-committers'
        '403':
          $ref: '#/components/responses/code_scanning_forbidden_read'
      x-github:
        githubCloudOnly: true
        enabledForGitHubApps: true
        category: billing
        subcategory: billing
  /accounts:
    get:
      summary: APIs.io Engineering Platform Get accounts
      description: Gets Postman billing account details for the given team.
      operationId: getAccounts
      tags:
      - Billing
      responses:
        '200':
          $ref: '#/components/responses/getAccounts'
        '400':
          $ref: '#/components/responses/invoicesNoTeam400Error'
        '401':
          $ref: '#/components/responses/unauthorizedError'
        '500':
          $ref: '#/components/responses/common500ErrorServerError'
  /accounts/{accountId}/invoices:
    get:
      summary: APIs.io Engineering Platform List account invoices
      description: Gets all invoices for a Postman billing account filtered by the status of the invoice.
      operationId: getAccountInvoices
      tags:
      - Billing
      responses:
        '200':
          $ref: '#/components/responses/getAccountInvoices'
        '400':
          $ref: '#/components/responses/invoiceMissingStatus400Error'
        '401':
          $ref: '#/components/responses/unauthorizedError'
        '403':
          $ref: '#/components/responses/invoicesForbidden403Error'
        '500':
          $ref: '#/components/responses/common500ErrorServerError'
      parameters:
      - $ref: '#/components/parameters/billingAccountId'
      - $ref: '#/components/parameters/billingAccountStatus'
components:
  responses:
    invoicesNoTeam400Error:
      description: Bad Request
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/invoicesNoTeam400Error'
          example:
            type: https://api.postman.com/problems/bad-request
            title: Malformed request
            status: 400
            detail: You must be part of a team
    invoicesForbidden403Error:
      description: Forbidden
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/invoicesForbidden403Error'
          example:
            type: https://api.postman.com/problems/forbidden
            title: Forbidden
            status: 403
            detail: You are not authorized to perform this action
    getAccountInvoices:
      description: Successful Response
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/getAccountInvoices'
          example:
            data:
            - id: inv_7UDSYBJPGQU93N7M
              status: PAID
              issuedAt: '2023-10-12'
              totalAmount:
                value: 440
                currency: USD
              links:
                web:
                  href: https://pay.postman.com/invoices/pay?invoice_public_id=inv_7UDSYBJPGQU93N7M
    code_scanning_forbidden_read:
      description: Response if GitHub Advanced Security is not enabled for this repository
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/basic-error'
    getAccounts:
      description: Successful Response
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/invoicesAccountInfo'
          example:
            billingEmail: taylor.lee@example.com
            id: 372691
            salesChannel: SELF_SERVE
            slots:
              available: 8
              consumed: 2
              total: 10
              unbilled: 0
            state: PAID
            teamId: 380691
    common500ErrorServerError:
      description: Internal Server Error
      content:
        application/json:
          schema:
            type: object
            properties:
              error:
                type: object
                properties:
                  name:
                    type: string
                    description: The error name.
                    example: serverError
                  message:
                    type: string
                    description: The error message.
                    example: An error has occurred on the server.
          example:
            error:
              name: serverError
              message: An error has occurred on the server.
    invoiceMissingStatus400Error:
      description: Bad Request
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/invoiceMissingStatus400Error'
          example:
            type: https://api.postman.com/problems/bad-request
            title: Malformed request
            status: 400
            detail: Please provide a valid status to fetch invoices
    unauthorizedError:
      description: Unauthorized
      content:
        application/problem+json:
          schema:
            type: object
            properties:
              type:
                type: string
                format: uri-reference
                description: The [URI reference](https://www.rfc-editor.org/rfc/rfc3986) that identifies the type of problem.
                example: https://api.postman.com/problems/unauthorized
              title:
                type: string
                description: A short summary of the problem.
                example: Unauthorized
              detail:
                type: string
                description: Information about the error.
                example: An API key must be provided in the request header or query string
              status:
                type: number
                format: http-status-code
                description: The error's HTTP status code.
                example: 401
          example:
            type: https://api.postman.com/problems/unauthorized
            title: Unauthorized
            detail: An API key must be provided in the request header or query string
            status: 401
  schemas:
    basic-error:
      title: Basic Error
      description: Basic Error
      type: object
      properties:
        message:
          type: string
        documentation_url:
          type: string
        url:
          type: string
        status:
          type: string
    invoicesNoTeam400Error:
      title: Bad Request
      type: object
      properties:
        type:
          type: string
          format: uri
          description: The error type.
          example: https://api.postman.com/problems/bad-request
        title:
          type: string
          description: A short summary of the error.
          example: Malformed request
        status:
          type: number
          format: http-status-code
          description: The error's HTTP status code.
          example: 400
        detail:
          type: string
          description: Details about the occurrence of the error.
          example: You must be part of a team
    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: taylor.lee@example.com
        id:
          type: integer
          description: The account's ID.
          example: 12345678
        state:
          type: string
          description: 'The account''s current state:

            - `FREE`

            - `PAID`

            - `EXPIRED_TRIAL`

            - `OVERDUE`

            - `SUSPENDED`

            - `BLOCKED`

            - `PAYMENT_DISPUTED`

            '
          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:

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

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

            '
          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
    getAccountInvoices:
      type: object
      required:
      - data
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/invoiceData'
    advanced-security-active-committers-user:
      type: object
      properties:
        user_login:
          type: string
        last_pushed_date:
          type: string
          example: '2021-11-03'
      required:
      - user_login
      - last_pushed_date
    invoicesForbidden403Error:
      title: Forbidden
      type: object
      properties:
        type:
          type: string
          format: uri
          description: The error type.
          example: https://api.postman.com/problems/forbidden
        title:
          type: string
          description: A short summary of the error.
          example: Forbidden
        status:
          type: number
          format: http-status-code
          description: The error's HTTP status code.
          example: 403
        detail:
          type: string
          description: Details about the occurrence of the error.
          example: You are not authorized to perform this action
    advanced-security-active-committers:
      type: object
      properties:
        total_advanced_security_committers:
          type: integer
          example: 25
        total_count:
          type: integer
          example: 2
        repositories:
          type: array
          items:
            $ref: '#/components/schemas/advanced-security-active-committers-repository'
      required:
      - repositories
    invoiceMissingStatus400Error:
      title: Missing Status
      type: object
      properties:
        type:
          type: string
          format: uri
          description: The error type.
          example: https://api.postman.com/problems/bad-request
        title:
          type: string
          description: A short summary of the error.
          example: Malformed request
        status:
          type: number
          format: http-status-code
          description: The error's HTTP status code.
          example: 400
        detail:
          type: string
          description: Details about the occurrence of the error.
          example: Please provide a valid status to fetch invoices
    advanced-security-active-committers-repository:
      type: object
      properties:
        name:
          type: string
          example: octocat/Hello-World
        advanced_security_committers:
          type: integer
          example: 25
        advanced_security_committers_breakdown:
          type: array
          items:
            $ref: '#/components/schemas/advanced-security-active-committers-user'
      required:
      - name
      - advanced_security_committers
      - advanced_security_committers_breakdown
    invoiceData:
      title: Account Invoice
      type: object
      description: Information about the invoice.
      properties:
        id:
          type: string
          description: The invoice's ID.
          example: inv_7UDSYBJPGQU93N7M
        status:
          type: string
          description: The invoice's status.
          example: PAID
        issuedAt:
          type: string
          format: date
          description: The date on which the invoice was issued.
          example: '2023-10-12'
        totalAmount:
          type: object
          description: Information about the invoice's total billed amount.
          properties:
            value:
              type: integer
              description: The amount billed.
              example: 440
            currency:
              type: string
              description: The currency of the billed amount. Currently only supports the `USD` value.
              example: USD
        links:
          type: object
          description: A [JSON API spec](https://jsonapi.org/format/#document-links) object containing hypermedia links.
          properties:
            web:
              type: object
              description: An object containing web-based account references.
              properties:
                href:
                  type: string
                  format: url
                  description: A URL where you can download the invoice in PDF and view details.
                  example: https://pay.postman.com/invoices/pay?invoice_public_id=inv_7UDSYBJPGQU93N7M
  examples:
    advanced-security-active-committers:
      value:
        total_advanced_security_committers: 2
        total_count: 2
        repositories:
        - name: octocat-org/Hello-World
          advanced_security_committers: 2
          advanced_security_committers_breakdown:
          - user_login: octocat
            last_pushed_date: '2021-11-03'
          - user_login: octokitten
            last_pushed_date: '2021-10-25'
        - name: octocat-org/server
          advanced_security_committers: 1
          advanced_security_committers_breakdown:
          - user_login: octokitten
            last_pushed_date: '2021-10-26'
  parameters:
    billingAccountStatus:
      name: status
      in: query
      required: true
      description: The account's status.
      schema:
        type: string
        enum:
        - PAID
        example: PAID
    org:
      name: org
      description: The organization name. The name is not case sensitive.
      in: path
      required: true
      schema:
        type: string
    per-page:
      name: per_page
      description: The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
      in: query
      schema:
        type: integer
        default: 30
    page:
      name: page
      description: The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
      in: query
      schema:
        type: integer
        default: 1
    billingAccountId:
      name: accountId
      in: path
      required: true
      description: The account's ID.
      schema:
        type: string
        example: '123456'
    enterprise:
      name: enterprise
      description: The slug version of the enterprise name. You can also substitute this value with the enterprise id.
      in: path
      required: true
      schema:
        type: string
  securitySchemes:
    hmac:
      type: apiKey
      name: Authorization
      in: header
      description: Amazon Signature authorization v4
      x-amazon-apigateway-authtype: awsSigv4
externalDocs:
  description: Amazon Web Services documentation
  url: https://docs.aws.amazon.com/apigateway/
x-hasEquivalentPaths: true