@inklok/api-spec 7.6.1 → 7.7.0

package/openapi.yaml

@@ -8,7 +8,7 @@ info:
     Authenticate using an API key or bearer token, then use the resources below to manage
     templates, agreements, documents, and signing. For your first integration, start with
     the Quick Start guide.
-  version: "7.6.1"
+  version: "7.7.0"
   contact:
     name: Inklok API Support
     email: support@inklok.com
@@ -325,6 +325,29 @@ paths:
         '500':
           $ref: '#/components/responses/InternalServerError'
 
+  /me/billing:
+    get:
+      operationId: getMeBilling
+      summary: Get billing state for the current account
+      x-internal: true
+      x-visibility: internal
+      description: |
+        Returns the authenticated account's Billing Subscription authority record
+        and the derived entitlement projection used by the application UI.
+      tags:
+        - Me
+      responses:
+        '200':
+          description: Successfully retrieved billing state
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/MeBillingResponse'
+        '401':
+          $ref: '#/components/responses/Unauthorized'
+        '500':
+          $ref: '#/components/responses/InternalServerError'
+
   /platform/overview:
     get:
       operationId: getPlatformOverview
@@ -504,6 +527,65 @@ paths:
         '500':
           $ref: '#/components/responses/InternalServerError'
 
+  /platform/api-usage:
+    get:
+      operationId: getPlatformApiUsage
+      summary: Get Platform API usage health
+      x-visibility: internal
+      description: |
+        Returns a small operational API usage health view for platform administrators.
+        This endpoint uses existing usage counters and does not expose customer-facing analytics.
+      x-required-global-roles: [PLATFORM_ADMIN]
+      tags:
+        - Platform
+      parameters:
+        - in: query
+          name: window
+          schema:
+            type: string
+            enum:
+              - 1h
+              - 24h
+              - 7d
+              - 30d
+            default: 24h
+          description: Usage window to inspect.
+        - in: query
+          name: sort
+          schema:
+            type: string
+            enum:
+              - throttleCount
+              - usagePercentage
+            default: throttleCount
+          description: Sort order for returned organizations.
+        - in: query
+          name: limit
+          schema:
+            type: integer
+            minimum: 1
+            maximum: 100
+            default: 25
+          description: Maximum number of organizations to return.
+        - in: query
+          name: cursor
+          schema:
+            type: string
+          description: Opaque pagination cursor returned by the previous response.
+      responses:
+        '200':
+          description: Successfully retrieved Platform API usage health
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/PlatformApiUsageResponse'
+        '401':
+          $ref: '#/components/responses/Unauthorized'
+        '403':
+          $ref: '#/components/responses/Forbidden'
+        '500':
+          $ref: '#/components/responses/InternalServerError'
+
   /platform/ses:
     get:
       operationId: getPlatformSes
@@ -3580,6 +3662,86 @@ components:
         profile:
           $ref: '#/components/schemas/BootstrapProfile'
 
+    MeBillingSubscription:
+      type: object
+      additionalProperties: false
+      required:
+        - source
+        - currentPlan
+        - status
+        - billingInterval
+        - currentBillingPeriodStart
+        - currentBillingPeriodEnd
+        - renewalDate
+        - cancelAtPeriodEnd
+        - paddleCustomerId
+        - paddleSubscriptionId
+        - nextBilledAt
+        - nextExpectedBillingTransition
+      properties:
+        source:
+          type: string
+          enum: [PADDLE, INTERNAL]
+        currentPlan:
+          type: string
+          enum: [free, pro, team, enterprise]
+        status:
+          type: string
+        billingInterval:
+          type: string
+          enum: [day, week, month, year, unknown]
+        currentBillingPeriodStart:
+          type: string
+          format: date-time
+          nullable: true
+        currentBillingPeriodEnd:
+          type: string
+          format: date-time
+          nullable: true
+        renewalDate:
+          type: string
+          format: date-time
+          nullable: true
+        cancelAtPeriodEnd:
+          type: boolean
+        paddleCustomerId:
+          type: string
+          nullable: true
+        paddleSubscriptionId:
+          type: string
+          nullable: true
+        nextBilledAt:
+          type: string
+          format: date-time
+          nullable: true
+        nextExpectedBillingTransition:
+          type: string
+          format: date-time
+          nullable: true
+
+    MeBillingResponse:
+      type: object
+      additionalProperties: false
+      required:
+        - accountId
+        - plan
+        - subscriptionStatus
+        - limits
+        - billingSubscription
+      properties:
+        accountId:
+          type: string
+        plan:
+          type: string
+          enum: [free, pro, team, enterprise]
+        subscriptionStatus:
+          type: string
+        limits:
+          type: object
+          additionalProperties: true
+        billingSubscription:
+          $ref: '#/components/schemas/MeBillingSubscription'
+
     PlatformDailyEmailCounts:
       type: object
       required:
@@ -4087,6 +4249,7 @@ components:
         - accountId
         - isPersonal
         - createdAt
+        - sandboxForOrgId
         - entitlement
       properties:
         orgId:
@@ -4107,6 +4270,9 @@ components:
         createdAt:
           type: string
           format: date-time
+        sandboxForOrgId:
+          type: string
+          nullable: true
         entitlement:
           nullable: true
           allOf:
@@ -4316,6 +4482,191 @@ components:
           minimum: 0
           description: Enterprise custom included seat value. Ignored for non-Enterprise plans.
 
+    PlatformApiUsagePolicySummary:
+      type: object
+      required:
+        - totalApiRequests
+        - throttleCount
+        - configuredLimit
+        - peakUsage
+        - usagePercentage
+      properties:
+        totalApiRequests:
+          type: integer
+          minimum: 0
+        throttleCount:
+          type: integer
+          minimum: 0
+        configuredLimit:
+          type: integer
+          nullable: true
+          minimum: 0
+        peakUsage:
+          type: integer
+          minimum: 0
+        usagePercentage:
+          type: number
+          nullable: true
+          minimum: 0
+
+    PlatformApiUsageCategorySummary:
+      type: object
+      required:
+        - totalApiRequests
+        - throttleCount
+        - peakUsage
+      properties:
+        totalApiRequests:
+          type: integer
+          minimum: 0
+        throttleCount:
+          type: integer
+          minimum: 0
+        peakUsage:
+          type: integer
+          minimum: 0
+
+    PlatformApiUsageOrganization:
+      type: object
+      required:
+        - orgId
+        - organizationName
+        - accountId
+        - plan
+        - totalApiRequests
+        - throttleCount
+        - configuredApiLimit
+        - peakUsage
+        - usagePercentage
+        - lastRequestAt
+        - lastThrottleAt
+        - status
+        - breakdown
+      properties:
+        orgId:
+          type: string
+        organizationName:
+          type: string
+          nullable: true
+        accountId:
+          type: string
+          nullable: true
+        plan:
+          $ref: '#/components/schemas/Plan'
+        totalApiRequests:
+          type: integer
+          minimum: 0
+        throttleCount:
+          type: integer
+          minimum: 0
+        configuredApiLimit:
+          type: integer
+          nullable: true
+          minimum: 0
+        peakUsage:
+          type: integer
+          minimum: 0
+        usagePercentage:
+          type: number
+          nullable: true
+          minimum: 0
+        lastRequestAt:
+          type: string
+          nullable: true
+          format: date-time
+        lastThrottleAt:
+          type: string
+          nullable: true
+          format: date-time
+        status:
+          type: string
+          enum:
+            - THROTTLED
+            - NEAR_LIMIT
+            - WATCH
+            - OK
+        breakdown:
+          type: object
+          required:
+            - publishedApi
+            - firstParty
+            - production
+            - sandbox
+          properties:
+            publishedApi:
+              $ref: '#/components/schemas/PlatformApiUsagePolicySummary'
+            firstParty:
+              $ref: '#/components/schemas/PlatformApiUsagePolicySummary'
+            production:
+              $ref: '#/components/schemas/PlatformApiUsageCategorySummary'
+            sandbox:
+              $ref: '#/components/schemas/PlatformApiUsageCategorySummary'
+
+    PlatformApiUsageResponse:
+      type: object
+      required:
+        - window
+        - sort
+        - limit
+        - nextCursor
+        - organizations
+        - totalOrganizations
+        - dataSource
+        - generatedAt
+      properties:
+        window:
+          type: string
+          enum:
+            - 1h
+            - 24h
+            - 7d
+            - 30d
+        sort:
+          type: string
+          enum:
+            - throttleCount
+            - usagePercentage
+        limit:
+          type: integer
+          minimum: 1
+        nextCursor:
+          type: string
+          nullable: true
+        organizations:
+          type: array
+          items:
+            $ref: '#/components/schemas/PlatformApiUsageOrganization'
+        totalOrganizations:
+          type: integer
+          minimum: 0
+        dataSource:
+          type: object
+          required:
+            - table
+            - rollupTableUsed
+            - precision
+            - usagePercentageBasis
+          properties:
+            table:
+              type: string
+              enum:
+                - usage-counters
+            rollupTableUsed:
+              type: boolean
+            precision:
+              type: string
+              enum:
+                - minute
+                - day
+            usagePercentageBasis:
+              type: string
+              enum:
+                - peak_minute
+                - daily_capacity
+        generatedAt:
+          type: string
+          format: date-time
+
     PlatformCostsResponse:
       type: object
       required:

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@inklok/api-spec",
-  "version": "7.6.1",
+  "version": "7.7.0",
   "description": "Canonical OpenAPI specification for the Inklok public API.",
   "main": "openapi.yaml",
   "license": "MIT",