@inklok/api-spec 7.9.0 → 7.9.2

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.9.0"
+  version: "7.9.2"
   contact:
     name: Inklok API Support
     email: support@inklok.com
@@ -486,7 +486,7 @@ paths:
         content:
           application/json:
             schema:
-              $ref: '#/components/schemas/MeBillingSeatsUpdateRequest'
+              $ref: '#/components/schemas/MeBillingSeatsApplyRequest'
       responses:
         '200':
           description: Successfully updated seats
@@ -528,6 +528,45 @@ paths:
         '500':
           $ref: '#/components/responses/InternalServerError'
 
+  /me/billing/seats/preview:
+    post:
+      operationId: previewMeBillingSeats
+      summary: Preview an additional-seat change for the current account
+      x-internal: true
+      x-visibility: internal
+      description: |
+        Previews the Paddle financial impact of changing the Additional Seat
+        subscription item quantity without applying the subscription mutation.
+      tags:
+        - Me
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/MeBillingSeatsPreviewRequest'
+      responses:
+        '200':
+          description: Successfully previewed the seat change
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/MeBillingSeatsPreviewResponse'
+        '400':
+          $ref: '#/components/responses/BadRequest'
+        '401':
+          $ref: '#/components/responses/Unauthorized'
+        '403':
+          $ref: '#/components/responses/Forbidden'
+        '409':
+          $ref: '#/components/responses/Conflict'
+        '502':
+          $ref: '#/components/responses/BadGateway'
+        '503':
+          $ref: '#/components/responses/ServiceUnavailable'
+        '500':
+          $ref: '#/components/responses/InternalServerError'
+
   /platform/overview:
     get:
       operationId: getPlatformOverview
@@ -766,6 +805,54 @@ paths:
         '500':
           $ref: '#/components/responses/InternalServerError'
 
+  /platform/billing-activity:
+    get:
+      operationId: getPlatformBillingActivity
+      summary: Get Platform billing activity
+      x-visibility: internal
+      description: |
+        Returns normalized billing activity for one account, newest first.
+        Requires an authorized platform administrator.
+        Raw Paddle webhook payloads and payment details are not returned.
+      x-required-global-roles: [PLATFORM_ADMIN]
+      tags:
+        - Platform
+      parameters:
+        - in: query
+          name: accountId
+          required: true
+          schema:
+            type: string
+          description: Billing account ID to inspect.
+        - in: query
+          name: limit
+          schema:
+            type: integer
+            minimum: 1
+            maximum: 100
+            default: 25
+          description: Maximum number of activity rows to return.
+        - in: query
+          name: cursor
+          schema:
+            type: string
+          description: Opaque pagination cursor returned by the previous response.
+      responses:
+        '200':
+          description: Successfully retrieved Platform billing activity
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/PlatformBillingActivityResponse'
+        '400':
+          $ref: '#/components/responses/BadRequest'
+        '401':
+          $ref: '#/components/responses/Unauthorized'
+        '403':
+          $ref: '#/components/responses/Forbidden'
+        '500':
+          $ref: '#/components/responses/InternalServerError'
+
   /platform/ses:
     get:
       operationId: getPlatformSes
@@ -3934,7 +4021,7 @@ components:
           nullable: true
           minimum: 0
 
-    MeBillingSeatsUpdateRequest:
+    MeBillingSeatsPreviewRequest:
       type: object
       additionalProperties: false
       required:
@@ -3944,6 +4031,133 @@ components:
           type: integer
           minimum: 0
 
+    MeBillingSeatsApplyRequest:
+      type: object
+      additionalProperties: false
+      required:
+        - additionalSeats
+        - previewToken
+      properties:
+        additionalSeats:
+          type: integer
+          minimum: 0
+        previewToken:
+          type: string
+          description: Signed token returned by the seat-change preview endpoint.
+
+    MeBillingSeatsPreviewResponse:
+      type: object
+      additionalProperties: false
+      required:
+        - accountId
+        - subscriptionId
+        - currentAdditionalSeats
+        - proposedAdditionalSeats
+        - currentEffectiveSeatLimit
+        - proposedEffectiveSeatLimit
+        - direction
+        - prorationBillingMode
+        - memberLimitWarning
+        - immediateAdjustment
+        - nextRecurringAmount
+        - nextBillingDate
+        - billingCycle
+        - previewToken
+      properties:
+        accountId:
+          type: string
+        subscriptionId:
+          type: string
+        currentAdditionalSeats:
+          type: integer
+          minimum: 0
+        proposedAdditionalSeats:
+          type: integer
+          minimum: 0
+        currentEffectiveSeatLimit:
+          type: integer
+          nullable: true
+          minimum: 0
+        proposedEffectiveSeatLimit:
+          type: integer
+          nullable: true
+          minimum: 0
+        direction:
+          type: string
+          enum: [increase, decrease, unchanged]
+        prorationBillingMode:
+          type: string
+          enum: [prorated_immediately, prorated_next_billing_period]
+        memberLimitWarning:
+          type: object
+          nullable: true
+          additionalProperties: false
+          required:
+            - activeMembers
+            - proposedEffectiveSeatLimit
+            - overBy
+          properties:
+            activeMembers:
+              type: integer
+              minimum: 0
+            proposedEffectiveSeatLimit:
+              type: integer
+              minimum: 0
+            overBy:
+              type: integer
+              minimum: 1
+        immediateAdjustment:
+          type: object
+          additionalProperties: false
+          required:
+            - amount
+            - currencyCode
+            - kind
+          properties:
+            amount:
+              type: integer
+              description: Signed minor-unit amount. Positive charges now; negative credits now; zero means no immediate payment.
+            currencyCode:
+              type: string
+              nullable: true
+            kind:
+              type: string
+              enum: [charge, credit, none]
+        nextRecurringAmount:
+          type: object
+          additionalProperties: false
+          required:
+            - amount
+            - currencyCode
+          properties:
+            amount:
+              type: integer
+              nullable: true
+              description: Minor-unit recurring subscription total from Paddle preview.
+            currencyCode:
+              type: string
+              nullable: true
+        nextBillingDate:
+          type: string
+          format: date-time
+          nullable: true
+        billingCycle:
+          type: object
+          additionalProperties: false
+          required:
+            - interval
+            - frequency
+          properties:
+            interval:
+              type: string
+              enum: [day, week, month, year, unknown]
+            frequency:
+              type: integer
+              nullable: true
+              minimum: 1
+        previewToken:
+          type: string
+
     MeBillingResponse:
       type: object
       additionalProperties: false
@@ -4911,6 +5125,131 @@ components:
               enum:
                 - peak_minute
                 - daily_capacity
+      generatedAt:
+        type: string
+        format: date-time
+
+    PlatformBillingActivityType:
+      type: string
+      enum:
+        - plan_changed
+        - subscription_status_changed
+        - seats_changed
+        - billing_reconciled
+        - seat_change_failed
+
+    PlatformBillingActivitySource:
+      type: string
+      enum:
+        - paddle_webhook
+        - me_billing
+        - billing_reconciliation
+
+    PlatformBillingActivityItem:
+      type: object
+      required:
+        - accountId
+        - activityId
+        - activityKey
+        - activityType
+        - occurredAt
+        - source
+        - createdAt
+      properties:
+        accountId:
+          type: string
+        activityId:
+          type: string
+        activityKey:
+          type: string
+        activityType:
+          $ref: '#/components/schemas/PlatformBillingActivityType'
+        occurredAt:
+          type: string
+          format: date-time
+        source:
+          $ref: '#/components/schemas/PlatformBillingActivitySource'
+        actorUserId:
+          type: string
+          nullable: true
+        requestId:
+          type: string
+          nullable: true
+        paddleEventId:
+          type: string
+          nullable: true
+        paddleSubscriptionId:
+          type: string
+          nullable: true
+        oldPlan:
+          nullable: true
+          allOf:
+            - $ref: '#/components/schemas/Plan'
+        newPlan:
+          nullable: true
+          allOf:
+            - $ref: '#/components/schemas/Plan'
+        oldSubscriptionStatus:
+          type: string
+          nullable: true
+        newSubscriptionStatus:
+          type: string
+          nullable: true
+        oldAdditionalSeats:
+          type: integer
+          nullable: true
+          minimum: 0
+        newAdditionalSeats:
+          type: integer
+          nullable: true
+          minimum: 0
+        oldEffectiveSeatLimit:
+          type: integer
+          nullable: true
+          minimum: 0
+        newEffectiveSeatLimit:
+          type: integer
+          nullable: true
+          minimum: 0
+        attemptedAdditionalSeats:
+          type: integer
+          nullable: true
+          minimum: 0
+        attemptedEffectiveSeatLimit:
+          type: integer
+          nullable: true
+          minimum: 0
+        errorCode:
+          type: string
+          nullable: true
+        errorCategory:
+          type: string
+          nullable: true
+        createdAt:
+          type: string
+          format: date-time
+
+    PlatformBillingActivityResponse:
+      type: object
+      required:
+        - accountId
+        - items
+        - count
+        - nextCursor
+        - generatedAt
+      properties:
+        accountId:
+          type: string
+        items:
+          type: array
+          items:
+            $ref: '#/components/schemas/PlatformBillingActivityItem'
+        count:
+          type: integer
+          minimum: 0
+        nextCursor:
+          type: string
+          nullable: true
         generatedAt:
           type: string
           format: date-time

package/package.json

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