Skribble Billing and Credits API

openapi: 3.2.0
info:
  title: Skribble Billing and Credits API
  version: 1.2.4
  contact:
    name: Skribble Engineering
    url: https://skribble.com
    email: support@skribble.com
  license:
    name: Apache 2.0
    url: https://www.apache.org/licenses/LICENSE-2.0.html
  termsOfService: https://www.skribble.com/en-eu/terms-of-use/
  description: 'Operations tagged Billing and Credits across 2 of this provider''s published API definitions: skribble-validation-v1-openapi.yml, skribble-validation-v1-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://document-validation.skribble.com/v1
  description: Production - Switzerland
- url: https://document-validation.skribble.de/v1
  description: Production - Germany
security: []
tags:
- name: Billing and Credits
  description: Endpoints for managing account credits, billing information, and payment operations.
paths:
  /billing/credits/infos:
    get:
      operationId: getBillingCreditsInfos
      tags:
      - Billing and Credits
      summary: Credits information
      description: Get the list of credit usage information associated with specific endpoints
      security:
      - {}
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BillingCreditInfos'
        '400':
          $ref: '#/components/responses/BadRequest'
        '404':
          $ref: '#/components/responses/NotFound'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '500':
          $ref: '#/components/responses/ServerError'
        '503':
          $ref: '#/components/responses/ServiceUnavailable'
    servers:
    - url: https://document-validation.skribble.com/v1
      description: Production - Switzerland
    - url: https://document-validation.skribble.de/v1
      description: Production - Germany
  /billing/credits/usage:
    get:
      operationId: getBillingCreditsUsage
      tags:
      - Billing and Credits
      summary: Current credit usage
      description: Get credit usage list and details for current billing period
      security:
      - bearerAuth: []
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BillingCreditUsage'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '500':
          $ref: '#/components/responses/ServerError'
        '503':
          $ref: '#/components/responses/ServiceUnavailable'
    servers:
    - url: https://document-validation.skribble.com/v1
      description: Production - Switzerland
    - url: https://document-validation.skribble.de/v1
      description: Production - Germany
  /billing/credits/invoiced:
    get:
      operationId: getBillingCreditsInvoiced
      tags:
      - Billing and Credits
      summary: Invoiced credit details
      description: 'Get invoiced credit details for the most recent billing period or a

        specified time period'
      security:
      - bearerAuth: []
      parameters:
      - in: query
        name: period
        schema:
          type: string
        description: 'Format YYYY, YYYYMM, YYYYMMDD is supported. If not specified the last

          invoiced period is used by default'
        required: false
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BillingCreditUsage'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '500':
          $ref: '#/components/responses/ServerError'
        '503':
          $ref: '#/components/responses/ServiceUnavailable'
    servers:
    - url: https://document-validation.skribble.com/v1
      description: Production - Switzerland
    - url: https://document-validation.skribble.de/v1
      description: Production - Germany
components:
  responses:
    Forbidden:
      description: Forbidden
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ProblemResponse'
          example:
            type: https://document-validation.skribble.com/problem/feature-not-enabled
            method: POST
            path: /v1/validate/document
            status: 403
            message: Validation API access is not enabled for this business
    Unauthorized:
      description: Unauthorized
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ProblemResponse'
          example:
            type: https://document-validation.skribble.com/problem/problem-with-message
            method: GET
            path: /v1/validate/document
            status: 401
            message: Authentication required
    TooManyRequests:
      description: Too many requests
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ProblemResponse'
          example:
            type: https://document-validation.skribble.com/problem/problem-with-message
            method: POST
            path: /v1/validate/document
            status: 429
            message: Too many requests
    ServerError:
      description: Internal server error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ProblemResponse'
          example:
            type: https://document-validation.skribble.com/problem/problem-with-message
            method: POST
            path: /v1/validate/document
            status: 500
            message: Internal server error
    ServiceUnavailable:
      description: Service unavailable
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ProblemResponse'
          example:
            type: https://document-validation.skribble.com/problem/problem-with-message
            method: POST
            path: /v1/validate/document
            status: 503
            message: Service unavailable
    BadRequest:
      description: Bad request
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ProblemResponse'
          example:
            type: https://document-validation.skribble.com/problem/problem-with-message
            method: POST
            path: /v1/validate/document
            status: 400
            message: Document could not be parsed
    NotFound:
      description: Not found
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ProblemResponse'
          example:
            type: https://document-validation.skribble.com/problem/entity-not-found
            method: GET
            path: /v1/infos/00000000-0000-0000-0000-000000000000/validation
            status: 404
            message: Resource not found
  schemas:
    ProblemResponse:
      title: Problem
      type: object
      description: 'Error response envelope returned for all 4xx and 5xx responses with a JSON body.

        Follows a Problem+JSON-style shape. The `key` field is optional and reserved

        for future use.'
      required:
      - type
      - method
      - path
      - status
      - message
      properties:
        type:
          type: string
          format: uri
          description: 'URI identifying the problem category. The host of this URI depends on

            the environment the request was made against (e.g.

            `document-validation.skribble.com` and `document-validation.skribble.de`

            for the production regions; other environments use their respective

            hosts). Match on the path segment after `/problem/` rather than the full

            URI. Known values:


            - `https://document-validation.skribble.com/problem/problem-with-message` — generic error with a message

            - `https://document-validation.skribble.com/problem/entity-not-found` — requested resource does not exist

            - `https://document-validation.skribble.com/problem/feature-not-enabled` — a required feature is not enabled for the business

            - `https://document-validation.skribble.com/problem/constraint-violation` — request violates a domain constraint

            - `https://document-validation.skribble.com/problem/limit-exceeded` — a usage limit was exceeded'
          example: https://document-validation.skribble.com/problem/problem-with-message
        method:
          type: string
          description: HTTP method of the failing request.
          example: POST
        path:
          type: string
          description: Request URI of the failing request.
          example: /v1/validate/document
        status:
          type: integer
          description: HTTP status code, mirroring the response status line.
          example: 400
        key:
          type: string
          description: Optional machine-readable error key. Reserved for future use.
        message:
          type: string
          description: Human-readable error message.
          example: Document could not be parsed
    CreditInfo:
      type: object
      properties:
        sku:
          type: string
          description: SKU of the API endpoint
          example: 01-01
        endpoint:
          type: string
          description: API endpoint
          example: /validate/document
        credits:
          type: integer
          description: Credit usage per successful API endpoint call
          example: 2
    BillingCreditUsage:
      type: object
      properties:
        period:
          type: string
          description: Billing period in YYYYMM format
          example: '20240528'
        usage:
          type: array
          description: Array of consumptions, each detailing an endpoint use and its credit usage
          items:
            $ref: '#/components/schemas/CreditUsage'
        requests:
          type: integer
          description: Total of requests made
          example: 2
        credits:
          type: integer
          description: Total of credits used
          example: 4
    CreditUsage:
      type: object
      properties:
        endpoint:
          type: string
          description: The API endpoint being consumed
          example: /validate/document
        requests:
          type: integer
          description: Number of credits consumed by the endpoint call
          example: 2
        credits:
          type: integer
          description: The number of credits consumed through the corresponding endpoint
          example: 4
    BillingCreditInfos:
      type: object
      properties:
        validFrom:
          type: string
          format: date-time
          description: ISO 8601 date-time in UTC
          example: '2024-05-30T13:45:00Z'
        consumptions:
          type: array
          description: Array of consumptions, each with endpoint details and its credit cost
          items:
            $ref: '#/components/schemas/CreditInfo'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
x-refined-from:
- skribble-validation-v1-openapi.yml
- skribble-validation-v1-openapi.yml