Orb License Type API

openapi: 3.2.0
info:
  title: Reference License Type API
  description: 'Orb''s API is built with the following principles in mind:


    1. **Predictable developer experience**: Where applicable, the Orb API uses industry-standard patterns such as

    cursor-based pagination and standardized error output. To help with debugging in critical API

    actions, the API always strives to provide detailed and actionable error messages. Aliases

    such as external customer IDs aid in fast integration times.

    2. **Reliably real time**: Orb''s event-based APIs, such as event ingestion are designed to handle extremely high

    throughput and scale with concurrent load. Orb also provides a real-time event-level credits

    ledger and a highly performant webhooks architecture.

    3. **Flexibility at the forefront**: Features like timezone localization and the ability to amend historical usage

    show the flexible nature of the platform.


    You can download the latest OpenAPI spec here - pass `?version=3.0` for an

    OpenAPI 3.0-compatible spec.'
  contact:
    name: Orb, Inc.
    url: https://www.withorb.com/
    email: team@withorb.com
  version: '1.0'
servers:
- url: https://api.withorb.com/v1
  description: Production server
security:
- APIKeyAuth: []
tags:
- name: LicenseType
  description: 'The LicenseType resource represents a type of license that can be assigned to users.

    License types are used during billing by grouping metrics on the configured grouping key.'
paths:
  /license_types:
    get:
      tags:
      - LicenseType
      summary: List license types
      description: 'This endpoint returns a list of all license types configured for the account, ordered in ascending order by creation time.


        License types are used to group licenses and define billing behavior. Each license type has a name and a

        grouping key that determines how metrics are aggregated for billing purposes.'
      operationId: list-license-types
      parameters:
      - required: false
        style: form
        schema:
          type: integer
          maximum: 100.0
          minimum: 1.0
          title: Limit
          description: The number of items to fetch. Defaults to 20.
          default: 20
        name: limit
        in: query
      - required: false
        style: form
        schema:
          oneOf:
          - type: string
          - type: 'null'
          title: Cursor
          description: Cursor for pagination. This can be populated by the `next_cursor` value returned from the initial request.
        name: cursor
        in: query
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LicenseTypes'
        '400':
          description: Bad Request
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/400Error'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/401Error'
        '404':
          description: Not Found
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/404Error'
        '409':
          description: Conflict
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/409Error'
        '413':
          description: Content Too Large
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/413Error'
        '429':
          description: Too Many Requests
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/429Error'
        '500':
          description: Internal Server Error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/500Error'
    post:
      tags:
      - LicenseType
      summary: Create license type
      description: 'This endpoint is used to create a new license type.


        License types are used to group licenses and define billing behavior. Each license type has a name and a

        grouping key that determines how metrics are aggregated for billing purposes.'
      operationId: create-license-type
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/NewLicenseType'
        required: true
      responses:
        '201':
          description: Created
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LicenseType'
        '400':
          description: Bad Request
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/400Error'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/401Error'
        '404':
          description: Not Found
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/404Error'
        '409':
          description: Conflict
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/409Error'
        '413':
          description: Content Too Large
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/413Error'
        '429':
          description: Too Many Requests
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/429Error'
        '500':
          description: Internal Server Error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/500Error'
  /license_types/{license_type_id}:
    get:
      tags:
      - LicenseType
      summary: Fetch license type
      description: 'This endpoint returns a license type identified by its license_type_id.


        Use this endpoint to retrieve details about a specific license type, including its name and grouping key.'
      operationId: fetch-license-type
      parameters:
      - required: true
        style: simple
        schema:
          type: string
        name: license_type_id
        in: path
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LicenseType'
        '400':
          description: Bad Request
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/400Error'
        '401':
          description: Unauthorized
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/401Error'
        '404':
          description: Not Found
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/404Error'
        '409':
          description: Conflict
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/409Error'
        '413':
          description: Content Too Large
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/413Error'
        '429':
          description: Too Many Requests
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/429Error'
        '500':
          description: Internal Server Error
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/500Error'
components:
  schemas:
    RequestTooLargeError:
      properties:
        type:
          type: string
          enum:
          - https://docs.withorb.com/reference/error-responses#413-request-too-large
          title: Type
        status:
          type: integer
          enum:
          - 413
          title: Status
        detail:
          oneOf:
          - type: string
          - type: 'null'
          title: Detail
        title:
          oneOf:
          - type: string
          - type: 'null'
          title: Title
      type: object
      required:
      - type
      - status
      title: RequestTooLargeError
    401Error:
      $ref: '#/components/schemas/AuthorizationError'
      title: 401Error
    AuthorizationError:
      properties:
        type:
          type: string
          enum:
          - https://docs.withorb.com/reference/error-responses#401-authentication-error
          title: Type
        status:
          type: integer
          enum:
          - 401
          title: Status
        detail:
          oneOf:
          - type: string
          - type: 'null'
          title: Detail
        title:
          oneOf:
          - type: string
          - type: 'null'
          title: Title
      type: object
      required:
      - type
      - status
      title: AuthorizationError
    429Error:
      $ref: '#/components/schemas/TooManyRequests'
      title: 429Error
    FeatureNotAvailableError:
      properties:
        type:
          type: string
          enum:
          - https://docs.withorb.com/reference/error-responses#404-feature-not-available
          title: Type
        status:
          type: integer
          enum:
          - 400
          title: Status
        detail:
          oneOf:
          - type: string
          - type: 'null'
          title: Detail
        title:
          oneOf:
          - type: string
          - type: 'null'
          title: Title
      type: object
      required:
      - type
      - status
      title: FeatureNotAvailableError
    413Error:
      oneOf:
      - $ref: '#/components/schemas/RequestTooLargeError'
      - $ref: '#/components/schemas/ResourceTooLargeError'
      - $ref: '#/components/schemas/TooManyResultsError'
    IdempotencyRequestMismatch:
      properties:
        type:
          type: string
          enum:
          - https://docs.withorb.com/reference/error-responses#409-resource-conflict
          title: Type
        status:
          type: integer
          enum:
          - 409
          title: Status
        detail:
          oneOf:
          - type: string
          - type: 'null'
          title: Detail
        title:
          oneOf:
          - type: string
          - type: 'null'
          title: Title
      type: object
      required:
      - type
      - status
      title: IdempotencyRequestMismatch
    TooManyRequests:
      properties:
        type:
          type: string
          enum:
          - https://docs.withorb.com/reference/error-responses#429-too-many-requests
          title: Type
        status:
          type: integer
          enum:
          - 429
          title: Status
        detail:
          oneOf:
          - type: string
          - type: 'null'
          title: Detail
        title:
          oneOf:
          - type: string
          - type: 'null'
          title: Title
      type: object
      required:
      - type
      - status
      title: TooManyRequests
    LicenseType:
      properties:
        id:
          type: string
          title: Id
          description: The Orb-assigned unique identifier for the license type.
        name:
          type: string
          title: Name
          description: The name of the license type.
        grouping_key:
          type: string
          title: Grouping Key
          description: The key used for grouping licenses of this type. This is typically a user identifier field.
      type: object
      required:
      - id
      - name
      - grouping_key
      title: LicenseType
      description: 'The LicenseType resource represents a type of license that can be assigned to users.

        License types are used during billing by grouping metrics on the configured grouping key.'
    ResourceTooLargeError:
      properties:
        type:
          type: string
          enum:
          - https://docs.withorb.com/reference/error-responses#413-resource-too-large
          title: Type
        status:
          type: integer
          enum:
          - 413
          title: Status
        detail:
          oneOf:
          - type: string
          - type: 'null'
          title: Detail
        title:
          oneOf:
          - type: string
          - type: 'null'
          title: Title
      type: object
      required:
      - type
      - status
      title: ResourceTooLargeError
    409Error:
      $ref: '#/components/schemas/IdempotencyRequestMismatch'
      title: 409Error
    TooManyResultsError:
      properties:
        type:
          type: string
          enum:
          - https://docs.withorb.com/reference/error-responses#413-too-many-results
          title: Type
        status:
          type: integer
          enum:
          - 413
          title: Status
        detail:
          oneOf:
          - type: string
          - type: 'null'
          title: Detail
        title:
          oneOf:
          - type: string
          - type: 'null'
          title: Title
      type: object
      required:
      - type
      - status
      title: TooManyResultsError
    PaginationMetadata:
      properties:
        has_more:
          type: boolean
          title: Has More
        next_cursor:
          oneOf:
          - type: string
          - type: 'null'
          title: Next Cursor
      type: object
      required:
      - has_more
      - next_cursor
      title: PaginationMetadata
    ServerError:
      properties:
        type:
          type: string
          enum:
          - https://docs.withorb.com/reference/error-responses#500-internal-server-error
          title: Type
        status:
          type: integer
          title: Status
        detail:
          oneOf:
          - type: string
          - type: 'null'
          title: Detail
        title:
          oneOf:
          - type: string
          - type: 'null'
          title: Title
      type: object
      required:
      - type
      - status
      title: ServerError
    ResourceNotFoundError:
      properties:
        type:
          type: string
          enum:
          - https://docs.withorb.com/reference/error-responses#404-resource-not-found
          title: Type
        status:
          type: integer
          enum:
          - 404
          title: Status
        detail:
          oneOf:
          - type: string
          - type: 'null'
          title: Detail
        title:
          type: string
          title: Title
      type: object
      required:
      - type
      - status
      - title
      title: ResourceNotFoundError
    404Error:
      oneOf:
      - $ref: '#/components/schemas/FeatureNotAvailableError'
      - $ref: '#/components/schemas/ResourceNotFoundError'
      - $ref: '#/components/schemas/URLNotFound'
    URLNotFound:
      properties:
        type:
          type: string
          enum:
          - https://docs.withorb.com/reference/error-responses#404-url-not-found
          title: Type
        status:
          type: integer
          enum:
          - 404
          title: Status
        detail:
          oneOf:
          - type: string
          - type: 'null'
          title: Detail
        title:
          oneOf:
          - type: string
          - type: 'null'
          title: Title
      type: object
      required:
      - type
      - status
      title: URLNotFound
    DuplicateResourceCreationError:
      properties:
        type:
          type: string
          enum:
          - https://docs.withorb.com/reference/error-responses#400-duplicate-resource-creation
          title: Type
        status:
          type: integer
          enum:
          - 400
          title: Status
        detail:
          oneOf:
          - type: string
          - type: 'null'
          title: Detail
        title:
          oneOf:
          - type: string
          - type: 'null'
          title: Title
      type: object
      required:
      - type
      - status
      title: DuplicateResourceCreationError
    LicenseTypes:
      properties:
        data:
          items:
            $ref: '#/components/schemas/LicenseType'
          type: array
          title: Data
        pagination_metadata:
          $ref: '#/components/schemas/PaginationMetadata'
      type: object
      required:
      - data
      - pagination_metadata
      title: LicenseTypes
    RequestValidationError:
      properties:
        type:
          type: string
          enum:
          - https://docs.withorb.com/reference/error-responses#400-request-validation-errors
          title: Type
        status:
          type: integer
          enum:
          - 400
          title: Status
        detail:
          oneOf:
          - type: string
          - type: 'null'
          title: Detail
        title:
          oneOf:
          - type: string
          - type: 'null'
          title: Title
        validation_errors:
          items: {}
          type: array
          title: Validation Errors
      type: object
      required:
      - type
      - status
      - validation_errors
      title: RequestValidationError
    400Error:
      oneOf:
      - $ref: '#/components/schemas/ConstraintViolationError'
      - $ref: '#/components/schemas/DuplicateResourceCreationError'
      - $ref: '#/components/schemas/RequestValidationError'
    500Error:
      $ref: '#/components/schemas/ServerError'
      title: 500Error
    ConstraintViolationError:
      properties:
        type:
          type: string
          enum:
          - https://docs.withorb.com/reference/error-responses#400-constraint-violation
          title: Type
        status:
          type: integer
          enum:
          - 400
          title: Status
        detail:
          oneOf:
          - type: string
          - type: 'null'
          title: Detail
        title:
          oneOf:
          - type: string
          - type: 'null'
          title: Title
      type: object
      required:
      - type
      - status
      title: ConstraintViolationError
    NewLicenseType:
      properties:
        name:
          type: string
          minLength: 1
          title: Name
          description: The name of the license type.
        grouping_key:
          type: string
          minLength: 1
          title: Grouping Key
          description: The key used for grouping licenses of this type. This is typically a user identifier field.
      additionalProperties: false
      type: object
      required:
      - name
      - grouping_key
      title: NewLicenseType
  securitySchemes:
    APIKeyAuth:
      type: http
      description: API Keys can be issued in the Orb's web application.
      scheme: bearer
x-provenance:
  method: harvested
  publisher: Orb
  source: https://docs.withorb.com/api-reference/orb-openapi.json
  note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
    stamped by stamp-openapi-provenance.py (roadmap#793)