framefetch-net Billing API

openapi: 3.2.0
info:
  title: Framefetch Net Billing API
  version: 1.7.0
  contact:
    name: FrameFetch
    url: https://framefetch.net
  termsOfService: https://framefetch.net/impressum
  description: 'Operations tagged Billing across 2 of this provider''s published API definitions: openapi.json, framefetch-net-openapi.json. Each path carries the servers of the definition it was published in.'
servers:
- url: https://framefetch.net
security:
- bearerAuth: []
tags:
- name: Billing
paths:
  /v1/billing/portal:
    post:
      operationId: createBillingPortal
      summary: Open a Stripe Billing Portal session (manage saved card, view invoices)
      description: Returns a link to the Stripe-hosted Billing Portal for this account's Stripe customer, where a human can update their saved card, download invoices, and review past payments. Requires at least one prior POST /v1/checkout purchase (which lazily creates the Stripe customer) — 409 PAYMENT_REQUIRED if none exists yet.
      responses:
        '200':
          description: Portal URL
          content:
            application/json:
              schema:
                type: object
                properties:
                  url:
                    type: string
        '401':
          $ref: '#/components/responses/Error'
        '409':
          $ref: '#/components/responses/Error'
      tags:
      - Billing
    servers:
    - url: https://framefetch.net
  /v1/billing/auto-topup:
    post:
      operationId: configureAutoTopup
      summary: Configure balance-floor auto-recharge (opt in/out)
      description: 'Opt in/out of an automatic off-session card recharge once the balance drops below a threshold. Enabling requires threshold_micros (integer, >= 10,000 micros / $0.01) and amount_micros (must equal one of the pack amounts: 5000000, 21000000, 112000000) and a Stripe customer with a saved card from a prior POST /v1/checkout — 409 PAYMENT_REQUIRED if no card is on file. Disabling only needs { "enabled": false }. At most one recharge fires per drop below the threshold; a declined card disables auto-topup and notifies the account by email.'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - enabled
              properties:
                enabled:
                  type: boolean
                threshold_micros:
                  type: integer
                  minimum: 10000
                  description: Recharge when the balance drops below this many micro-USD. Required to enable.
                amount_micros:
                  type: integer
                  enum:
                  - 5000000
                  - 21000000
                  - 112000000
                  description: Credit to add per recharge; must match a credit-pack amount. Required to enable.
      responses:
        '200':
          description: Current auto-topup config
          content:
            application/json:
              schema:
                type: object
                properties:
                  auto_topup:
                    type: object
                    properties:
                      enabled:
                        type: boolean
                      threshold_micros:
                        type: integer
                      amount_micros:
                        type: integer
        '400':
          $ref: '#/components/responses/Error'
        '401':
          $ref: '#/components/responses/Error'
        '409':
          $ref: '#/components/responses/Error'
      tags:
      - Billing
    servers:
    - url: https://framefetch.net
components:
  schemas:
    Error:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
            message:
              type: string
            hint:
              type: string
  responses:
    Error:
      description: Error envelope
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: 'API key from POST /v1/keys, sent as ''Authorization: Bearer <key>''.'
x-refined-from:
- openapi.json
- framefetch-net-openapi.json