sketchxflow-com Payments API

openapi: 3.2.0
info:
  title: SketchXFlow Payments API
  version: 0.1.0
tags:
- name: Payments
paths:
  /api/payments/pricing:
    get:
      tags:
      - Payments
      summary: Get Pricing Public
      description: 'Public pricing for the marketing + account pages. Prices come from Dodo

        Payments (the source of truth); coin allotments from platform_config.


        Never waits on Dodo. A warm instance answers from its 10-minute cache; a

        fresh one (Cloud Run scales to zero, so that''s most first visits) answers

        from the last good copy kept in Mongo, or — the very first time — from the

        price mirror (services/pricing_catalog, identical to Dodo''s prices), and

        refreshes from Dodo after the response. That first-visit fetch of ~12

        products used to cost the visitor 2.6s (measured by signals, 2026-10-08).'
      operationId: get_pricing_public_api_payments_pricing_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
  /api/payments/checkout:
    post:
      tags:
      - Payments
      summary: Create Checkout
      description: 'Create a Dodo Payments checkout session.


        Returns a checkout_url to redirect the user to.'
      operationId: create_checkout_api_payments_checkout_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CheckoutRequest'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CheckoutResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/payments/subscription:
    get:
      tags:
      - Payments
      summary: Get Subscription Status
      description: Get the current user's subscription status.
      operationId: get_subscription_status_api_payments_subscription_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
  /api/payments/subscription/cancel:
    post:
      tags:
      - Payments
      summary: Cancel Subscription
      description: Cancel the current subscription.
      operationId: cancel_subscription_api_payments_subscription_cancel_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CancelSubscriptionRequest'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/payments/subscription/change-plan:
    post:
      tags:
      - Payments
      summary: Change Plan
      description: Change the subscription plan (upgrade/downgrade).
      operationId: change_plan_api_payments_subscription_change_plan_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ChangePlanRequest'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/payments/portal:
    post:
      tags:
      - Payments
      summary: Create Portal Session
      description: Create a Dodo customer portal session for self-service billing management.
      operationId: create_portal_session_api_payments_portal_post
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
  /api/payments/history:
    get:
      tags:
      - Payments
      summary: Get Payment History
      description: Get the user's payment and coin transaction history.
      operationId: get_payment_history_api_payments_history_get
      parameters:
      - name: limit
        in: query
        required: false
        schema:
          type: integer
          default: 20
          title: Limit
      - name: offset
        in: query
        required: false
        schema:
          type: integer
          default: 0
          title: Offset
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/payments/receipt/{payment_id}:
    get:
      tags:
      - Payments
      summary: Download Receipt
      description: 'Download a PDF receipt/invoice for a payment from Dodo.


        Returns the PDF binary with Content-Disposition for download.'
      operationId: download_receipt_api_payments_receipt__payment_id__get
      parameters:
      - name: payment_id
        in: path
        required: true
        schema:
          type: string
          title: Payment Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/payments/sketchxflow-dodo-wh-9f3a7c:
    post:
      tags:
      - Payments
      summary: Dodo Webhook
      description: 'Handle incoming Dodo Payments webhook events.


        This endpoint is called by Dodo''s servers — no auth cookie required.

        Verification is done via webhook signature.'
      operationId: dodo_webhook_api_payments_sketchxflow_dodo_wh_9f3a7c_post
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
components:
  schemas:
    CheckoutResponse:
      properties:
        checkout_url:
          type: string
          title: Checkout Url
        session_id:
          type: string
          title: Session Id
      type: object
      required:
      - checkout_url
      - session_id
      title: CheckoutResponse
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
            - type: string
            - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
      - loc
      - msg
      - type
      title: ValidationError
    CancelSubscriptionRequest:
      properties:
        immediate:
          type: boolean
          title: Immediate
          default: false
      type: object
      title: CancelSubscriptionRequest
    CheckoutRequest:
      properties:
        type:
          type: string
          title: Type
        plan_id:
          anyOf:
          - type: string
          - type: 'null'
          title: Plan Id
        pack_id:
          anyOf:
          - type: string
          - type: 'null'
          title: Pack Id
        collection:
          anyOf:
          - type: string
          - type: 'null'
          title: Collection
        interval:
          type: string
          title: Interval
          default: month
      type: object
      required:
      - type
      title: CheckoutRequest
    ChangePlanRequest:
      properties:
        new_plan_id:
          type: string
          title: New Plan Id
      type: object
      required:
      - new_plan_id
      title: ChangePlanRequest
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError