@inklok/api-spec 7.7.0 → 7.7.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.7.0"
+  version: "7.7.2"
   contact:
     name: Inklok API Support
     email: support@inklok.com
@@ -348,6 +348,38 @@ paths:
         '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
@@ -3667,6 +3699,7 @@ components:
       additionalProperties: false
       required:
         - source
+        - productPlan
         - currentPlan
         - status
         - billingInterval
@@ -3674,14 +3707,19 @@ components:
         - currentBillingPeriodEnd
         - renewalDate
         - cancelAtPeriodEnd
+        - canceledAt
         - paddleCustomerId
         - paddleSubscriptionId
         - nextBilledAt
         - nextExpectedBillingTransition
+        - reconciliationRequested
       properties:
         source:
           type: string
           enum: [PADDLE, INTERNAL]
+        productPlan:
+          type: string
+          enum: [free, pro, team, enterprise]
         currentPlan:
           type: string
           enum: [free, pro, team, enterprise]
@@ -3704,6 +3742,10 @@ components:
           nullable: true
         cancelAtPeriodEnd:
           type: boolean
+        canceledAt:
+          type: string
+          format: date-time
+          nullable: true
         paddleCustomerId:
           type: string
           nullable: true
@@ -3718,12 +3760,15 @@ components:
           type: string
           format: date-time
           nullable: true
+        reconciliationRequested:
+          type: boolean
 
     MeBillingResponse:
       type: object
       additionalProperties: false
       required:
         - accountId
+        - currentPlan
         - plan
         - subscriptionStatus
         - limits
@@ -3731,6 +3776,9 @@ components:
       properties:
         accountId:
           type: string
+        currentPlan:
+          type: string
+          enum: [free, pro, team, enterprise]
         plan:
           type: string
           enum: [free, pro, team, enterprise]
@@ -3742,6 +3790,22 @@ components:
         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:
@@ -6616,6 +6680,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.7.0",
+  "version": "7.7.2",
   "description": "Canonical OpenAPI specification for the Inklok public API.",
   "main": "openapi.yaml",
   "license": "MIT",