FUSE Health Billing API

openapi: 3.2.0
info:
  title: FUSE Brand API (External) Billing API
  version: 1.0.0
  description: 'Server-to-server API exposing the FUSE brand-admin surface so a single brand/tenant can build its own admin frontend. Every request is authenticated with an API key bound to exactly one clinic; all data is auto-scoped to that clinic and cannot reach another brand''s data. Isolation is enforced by application-layer clinic filtering on every query.


    COVERAGE: 218 operations across 180 paths, and EVERY ONE is available to every brand. There is no per-clinic enablement step. What governs access: your API key and its scopes, the clinic the key belongs to (every read and write is filtered to it), your plan''s entitlements for the two commercially-gated areas — Affiliates (`AFFILIATES_TIER_REQUIRED`) and CRM Connect (`CRM_TIER_REQUIRED`) — and rate limits.


    AUTH: the external /api/v1 surface uses an API key (`x-api-key`, ApiKeyAuth). Key management (/api-keys) and /auth/signin live at the API root and use a brand-admin JWT (BearerAuth); /auth/signin itself is unauthenticated.


    SCOPES: every key carries scopes; read-only is the default and mutating endpoints require the `write` scope (403 INSUFFICIENT_SCOPE otherwise). Keys default to a 1-year expiry.


    RATE LIMITING: every endpoint may additionally return `429 Too Many Requests` with a `Retry-After` header; 429 is not repeated on each operation below.


    PLATFORM FIELDS: product cost, fees, pharmacy routing, doctor questions and FUSE approvals are set by FUSE, not by the brand. Any write (POST/PUT/PATCH/DELETE) whose JSON body carries one of those fields at any depth — for example `pharmacyPrice`, `shippingFeeUsd`, `coolerFeeUsd`, `pharmacyId`, `preferredPharmacyId`, `pharmacyProvider`, `requiredDoctorQuestions`, `facilitationFee`, `placeholderPrice`, `legalBusinessName`, `isTemplate` or `tenantManagerApproved` — is refused with `403 PLATFORM_FIELD`, whose `fields` array lists the offending paths; remove them and resend. (One exception: `POST /api/v1/products` still accepts the `pharmacyPrice` its schema requires, and ignores it.) 403 PLATFORM_FIELD is not repeated on each operation below.'
servers:
- url: https://api-dev.fusehealth.com
  description: Development
- url: https://api.fusehealth.com
  description: Production
security:
- ApiKeyAuth: []
tags:
- name: Billing
paths:
  /api/v1/stripe/connect/status:
    get:
      tags:
      - Billing
      summary: Stripe Connect account status
      operationId: getApiV1StripeConnectStatus
      description: Returns the clinic's Stripe Connect (payout account) status. External Stripe API, clinic-scoped, 5-min cache.
      security:
      - ApiKeyAuth: []
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
  /api/v1/billing/validate-coupon:
    get:
      tags:
      - Billing
      summary: Validate a subscription coupon code
      operationId: getApiV1BillingValidateCoupon
      description: Look up an active coupon by code.
      security:
      - ApiKeyAuth: []
      parameters:
      - in: query
        name: code
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                  data:
                    type: object
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
  /api/v1/billing/plans:
    get:
      tags:
      - Billing
      summary: List active brand subscription plans
      operationId: getApiV1BillingPlans
      description: Public plan catalogue (invite-only plans hidden).
      security:
      - ApiKeyAuth: []
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                  plans:
                    type: array
                    items:
                      type: object
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
  /api/v1/billing/current:
    get:
      tags:
      - Billing
      summary: Current subscription (stub, always null)
      operationId: getApiV1BillingCurrent
      description: Returns success with subscription null.
      security:
      - ApiKeyAuth: []
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                  subscription:
                    type:
                    - object
                    - 'null'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
  /api/v1/billing/basic-info:
    get:
      tags:
      - Billing
      summary: Basic subscription info for the key's clinic
      operationId: getApiV1BillingBasicInfo
      description: Status/tutorial/onboarding summary for the clinic's brand owner.
      security:
      - ApiKeyAuth: []
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                  data:
                    type: object
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
  /api/v1/billing/preview-upgrade:
    post:
      tags:
      - Billing
      summary: Preview proration for a plan change
      operationId: postApiV1BillingPreviewUpgrade
      description: Computes Stripe proration credit/charge for a plan change. Read-only (writes nothing).
      security:
      - ApiKeyAuth: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - newPlanId
              properties:
                newPlanId:
                  type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '409':
          description: Subscription expired, sync required.
  /api/v1/billing/cancel:
    post:
      tags:
      - Billing
      summary: Give 60 days' notice of cancellation
      operationId: postApiV1BillingCancel
      description: 'Gives the Customer Agreement''s 60-day notice of cancellation. Records the end

        date (`cancelsAt`, 60 days out) and sets the same date on the Stripe subscription; billing,

        portal access and patient checkout continue until then, when the subscription ends and the

        clinic is deactivated. Idempotent: a second call returns the dates already recorded. The

        notice can be withdrawn before the date with `POST /api/v1/billing/cancel/withdraw`.

        Write-scoped.'
      security:
      - ApiKeyAuth: []
      responses:
        '200':
          description: Notice recorded (or already recorded)
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                  message:
                    type: string
                  data:
                    type: object
                    properties:
                      cancelsAt:
                        type: string
                        format: date-time
                      cancellationRequestedAt:
                        type: string
                        format: date-time
                      noticeDays:
                        type: integer
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '409':
          description: 'The subscription is an unbilled trial (`code: TRIAL_HAS_NO_NOTICE`). An unbilled trial is never charged and expires on its own, so there is nothing to give notice on.'
        '502':
          description: The billing provider could not record the date; nothing was changed.
  /api/v1/billing/cancel/withdraw:
    post:
      tags:
      - Billing
      summary: Withdraw a cancellation notice before it runs out
      operationId: postApiV1BillingCancelWithdraw
      description: Clears the end date locally and on the Stripe subscription; the subscription simply continues. Write-scoped.
      security:
      - ApiKeyAuth: []
      responses:
        '200':
          description: Notice withdrawn
          content:
            application/json:
              schema:
                type: object
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          description: No cancellation notice to withdraw
        '502':
          description: The billing provider could not be updated; nothing was changed.
  /api/v1/billing/change:
    post:
      tags:
      - Billing
      summary: Change the clinic's subscription plan
      operationId: postApiV1BillingChange
      description: Upgrades/downgrades via Stripe proration or schedule update. Write-scoped.
      security:
      - ApiKeyAuth: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - newPlanId
              properties:
                newPlanId:
                  type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
components:
  responses:
    Forbidden:
      description: Authenticated but not permitted (insufficient scope, wrong role, or FUSE feature not enabled)
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
    NotFound:
      description: Resource not found (or not owned by the key's clinic)
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
    BadRequest:
      description: Bad request / business-rule failure (may include a `code`)
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
    Unauthorized:
      description: Missing, invalid, inactive, or expired API key (or JWT)
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
  schemas:
    ErrorEnvelope:
      description: 'Failure shape. NOTE: most modules use `message`; programs endpoints use `error`. Read both. Some errors include a machine-readable `code` and/or a `data` payload.'
      type: object
      properties:
        success:
          type: boolean
          enum:
          - false
        message:
          type: string
        error:
          type: string
        code:
          type: string
        data: {}
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: Clinic-scoped API key. Keep server-side; never expose in a browser or app bundle.
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: FUSE brand-admin JWT (from POST /auth/signin). Used ONLY by the key-management endpoints — the external /api/v1 surface never accepts JWTs, and API keys never work on key management.