@inklok/api-spec 7.6.2 → 7.7.1

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.2"
+  version: "7.7.1"
   contact:
     name: Inklok API Support
     email: support@inklok.com
@@ -325,6 +325,61 @@ 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'
+
+  /me/billing/customer-portal:
+    post:
+      operationId: createMeBillingCustomerPortalSession
+      summary: Create a Paddle customer portal session for the current account
+      x-internal: true
+      x-visibility: internal
+      description: |
+        Creates a short-lived authenticated Paddle customer portal URL for the
+        authenticated account's Paddle-managed billing subscription. The Paddle
+        API key is never exposed to the client, and the portal URL must not be cached.
+      tags:
+        - Me
+      responses:
+        '200':
+          description: Successfully created a customer portal session
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/MeBillingCustomerPortalResponse'
+        '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
@@ -3639,6 +3694,102 @@ 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'
+
+    MeBillingCustomerPortalResponse:
+      type: object
+      additionalProperties: false
+      required:
+        - url
+        - customerId
+        - subscriptionId
+      properties:
+        url:
+          type: string
+          format: uri
+        customerId:
+          type: string
+        subscriptionId:
+          type: string
+
     PlatformDailyEmailCounts:
       type: object
       required:
@@ -6513,6 +6664,20 @@ components:
           schema:
             $ref: '#/components/schemas/Error'
 
+    BadGateway:
+      description: Bad gateway - upstream service failed
+      content:
+        application/json:
+          schema:
+            $ref: '#/components/schemas/Error'
+
+    ServiceUnavailable:
+      description: Service unavailable - dependency or configuration unavailable
+      content:
+        application/json:
+          schema:
+            $ref: '#/components/schemas/Error'
+
     RateLimited:
       description: Too many requests
       content:

package/package.json

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