slideforge-dev Billing API

openapi: 3.2.0
info:
  title: SlideForge Billing API
  description: 'Agent-first PowerPoint generation. Send structured slide intents (a `form` plus typed fields) or a brief; get back a real, editable `.pptx`. The draw path is deterministic — no model renders your slide, so supplied numbers and text come out verbatim. Every response carries `status`, `fidelity` and `warnings` so an automated caller can tell whether the output is usable. $0.05 per slide; an unusable slide is not billed. Authenticate with a SlideForge API key (`Authorization: Bearer sf_live_…` or `X-API-Key`) — new accounts include 60 free slides, no credit card: https://slideforge.dev/sign-up'
  version: 5.356.0
servers:
- url: https://api.slideforge.dev
security:
- bearerAuth: []
- apiKeyAuth: []
tags:
- name: Billing
paths:
  /v1/billing/profile:
    get:
      tags:
      - Billing
      summary: Get billing profile
      description: Company/tax details used on invoices.
      operationId: get_billing_profile_v1_billing_profile_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
    put:
      tags:
      - Billing
      summary: Update billing profile
      description: Create or update the company/tax details used on invoices.
      operationId: put_billing_profile_v1_billing_profile_put
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BillingProfile'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /v1/billing/invoices:
    get:
      tags:
      - Billing
      summary: List invoices
      description: Invoiceable wallet top-ups for the caller, each with its invoice (if issued).
      operationId: list_invoices_v1_billing_invoices_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
    post:
      tags:
      - Billing
      summary: Issue an invoice
      description: Issue (or return the existing) invoice for one paid top-up. Requires a billing profile.
      operationId: post_invoice_v1_billing_invoices_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/IssueInvoiceRequest'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /v1/billing/invoices/{invoice_number}:
    get:
      tags:
      - Billing
      summary: Get an invoice
      description: Invoice metadata + a fresh signed download URL.
      operationId: get_invoice_v1_billing_invoices__invoice_number__get
      parameters:
      - name: invoice_number
        in: path
        required: true
        schema:
          type: string
          title: Invoice Number
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /v1/billing/checkout:
    post:
      tags:
      - Billing
      summary: Create a Stripe Checkout session
      description: 'Create a Stripe Checkout session for wallet top-up. Volume discounts: $50→+10%, $100→+15%, $200→+20%. Returns checkout_url to redirect the user to Stripe.'
      operationId: create_checkout_v1_billing_checkout_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CheckoutRequest'
        required: true
      responses:
        '200':
          description: Checkout session created
          content:
            application/json:
              schema: {}
        '400':
          description: Invalid amount
        '401':
          description: Authentication required
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /v1/topup/{session_id}:
    get:
      tags:
      - Billing
      summary: Open-tracked redirect into a Stripe Checkout session
      description: 'Records that a minted top-up link was actually opened, then 302s to Stripe. Public: the unguessable session id is the credential; only sessions this API minted (metadata.source=slideforge_wallet) are redirected.'
      operationId: topup_redirect_v1_topup__session_id__get
      parameters:
      - name: session_id
        in: path
        required: true
        schema:
          type: string
          title: Session Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '302':
          description: Redirect to Stripe Checkout (or the outcome page)
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /v1/billing/charge-saved:
    post:
      tags:
      - Billing
      summary: Charge saved card for instant top-up
      description: Charge the user's saved card (from auto top-up setup) for an instant wallet top-up. No Stripe Checkout redirect needed. Volume discounts apply.
      operationId: charge_saved_card_v1_billing_charge_saved_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CheckoutRequest'
        required: true
      responses:
        '200':
          description: Card charged, wallet credited
          content:
            application/json:
              schema: {}
        '400':
          description: No saved card or invalid amount
        '401':
          description: Authentication required
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /v1/billing/setup-intent:
    post:
      tags:
      - Billing
      summary: Create Stripe SetupIntent for card saving
      description: Creates a Stripe Customer (if needed) and SetupIntent. Returns client_secret for Stripe Elements card setup.
      operationId: create_setup_intent_v1_billing_setup_intent_post
      responses:
        '200':
          description: SetupIntent created
          content:
            application/json:
              schema: {}
        '401':
          description: Authentication required
  /v1/billing/autotopup:
    get:
      tags:
      - Billing
      summary: Get auto top-up settings
      description: Returns current auto top-up configuration including card info.
      operationId: get_autotopup_v1_billing_autotopup_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
    post:
      tags:
      - Billing
      summary: Save auto top-up settings
      description: Save auto top-up settings after card is confirmed via SetupIntent. Validates threshold/amount constraints and verifies payment method with Stripe.
      operationId: save_autotopup_v1_billing_autotopup_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AutoTopupSettings'
        required: true
      responses:
        '200':
          description: Settings saved
          content:
            application/json:
              schema: {}
        '400':
          description: Invalid settings
        '401':
          description: Authentication required
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    delete:
      tags:
      - Billing
      summary: Disable auto top-up
      description: Disable auto top-up. Keeps card on file for re-enabling later.
      operationId: delete_autotopup_v1_billing_autotopup_delete
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
  /v1/billing/plan:
    get:
      tags:
      - Billing
      summary: Current self-serve plan
      description: The account's plan (monthly/yearly), its ceiling and slides used this period, or null; plus the catalogue of plans and the default offer.
      operationId: get_plan_v1_billing_plan_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
    delete:
      tags:
      - Billing
      summary: Cancel the plan at period end
      description: The paid period stays usable; nothing is refunded.
      operationId: cancel_plan_v1_billing_plan_delete
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
  /v1/billing/plans/checkout:
    post:
      tags:
      - Billing
      summary: Start a plan
      description: Mints a Stripe subscription checkout for the named plan. 409 while a plan is open.
      operationId: plan_checkout_v1_billing_plans_checkout_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PlanCheckoutRequest'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /v1/billing/plan/overflow:
    post:
      tags:
      - Billing
      summary: Continue from wallet credit past the plan
      description: 'On (the default): past the plan''s slides, renders continue at $0.05 a slide from wallet credit.'
      operationId: plan_overflow_v1_billing_plan_overflow_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PlanOverflowRequest'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /v1/billing/plan/reactivate:
    post:
      tags:
      - Billing
      summary: Keep a cancelled plan
      description: Undoes cancel-at-period-end while the paid period is still running; the plan renews again.
      operationId: plan_reactivate_v1_billing_plan_reactivate_post
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
  /v1/billing/plan/upgrade:
    post:
      tags:
      - Billing
      summary: Upgrade monthly to yearly now
      description: Stripe invoices the yearly price less the unused part of the month; the ceiling resets.
      operationId: plan_upgrade_v1_billing_plan_upgrade_post
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
  /v1/billing/portal:
    post:
      tags:
      - Billing
      summary: Open the Stripe billing portal
      description: 'Mints a Stripe Billing Portal session for this account''s saved card: change the card behind the plan, cancel. 404 when no card is on file in this Stripe mode.'
      operationId: billing_portal_v1_billing_portal_post
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
components:
  schemas:
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
            - type: string
            - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
      type: object
      required:
      - loc
      - msg
      - type
      title: ValidationError
    IssueInvoiceRequest:
      properties:
        transaction_id:
          type: integer
          title: Transaction Id
      type: object
      required:
      - transaction_id
      title: IssueInvoiceRequest
    PlanCheckoutRequest:
      properties:
        plan:
          type: string
          title: Plan
      type: object
      required:
      - plan
      title: PlanCheckoutRequest
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    PlanOverflowRequest:
      properties:
        enabled:
          type: boolean
          title: Enabled
      type: object
      required:
      - enabled
      title: PlanOverflowRequest
    AutoTopupSettings:
      properties:
        enabled:
          type: boolean
          title: Enabled
          default: true
        threshold:
          type: number
          title: Threshold
        amount:
          type: number
          title: Amount
        payment_method_id:
          anyOf:
          - type: string
          - type: 'null'
          title: Payment Method Id
      type: object
      required:
      - threshold
      - amount
      title: AutoTopupSettings
    CheckoutRequest:
      properties:
        amount:
          type: number
          title: Amount
      type: object
      required:
      - amount
      title: CheckoutRequest
    BillingProfile:
      properties:
        legal_name:
          type: string
          title: Legal Name
        address_line1:
          anyOf:
          - type: string
          - type: 'null'
          title: Address Line1
        address_line2:
          anyOf:
          - type: string
          - type: 'null'
          title: Address Line2
        postcode:
          anyOf:
          - type: string
          - type: 'null'
          title: Postcode
        city:
          anyOf:
          - type: string
          - type: 'null'
          title: City
        country:
          type: string
          title: Country
        tax_id:
          anyOf:
          - type: string
          - type: 'null'
          title: Tax Id
        email:
          anyOf:
          - type: string
          - type: 'null'
          title: Email
      type: object
      required:
      - legal_name
      - country
      title: BillingProfile
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: 'SlideForge API key: `Authorization: Bearer sf_live_…`. Create one at https://slideforge.dev/console/keys'
    apiKeyAuth:
      type: apiKey
      in: header
      name: X-API-Key
      description: Same key, header form — for clients that cannot set Authorization.