sitegpt-ai

sitegpt-ai Billing API

The Billing API from sitegpt-ai — 2 operation(s) for billing.

GitHub OpenAPI

Operations 2

GET /api/v2/billing/subscription Get subscription #
GET /api/v2/billing/invoices List invoices #

Specifications

⚙
OpenAPI
https://artifacts.apis.io/sitegpt-ai/openapi/sitegpt-ai-billing-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://artifacts.apis.io/sitegpt-ai/json-schema/sitegpt-ai-conversation-schema.json
📊
JSONSchema
https://artifacts.apis.io/sitegpt-ai/json-schema/sitegpt-ai-chatbot-schema.json
📊
JSONSchema
https://artifacts.apis.io/sitegpt-ai/json-schema/sitegpt-ai-message-schema.json
📊
JSONSchema
https://artifacts.apis.io/sitegpt-ai/json-schema/sitegpt-ai-billing-subscription-schema.json
📊
JSONSchema
https://artifacts.apis.io/sitegpt-ai/json-schema/sitegpt-ai-invoice-schema.json
📊
JSONSchema
https://artifacts.apis.io/sitegpt-ai/json-schema/sitegpt-ai-knowledge-document-schema.json

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/sitegpt-ai:sitegpt-ai-billing-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

sitegpt-ai-billing-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: SiteGPT Agent Billing API
  version: 2.0.0
  description: Agent-facing API for managing SiteGPT chatbots, dashboard summaries, appearance media, knowledge, settings, conversations, leads, members, account profiles, usage, billing reads, and API tokens.
servers:
- url: https://sitegpt.ai
security:
- bearerAuth: []
tags:
- name: Billing
paths:
  /api/v2/billing/subscription:
    get:
      operationId: getBillingSubscription
      summary: Get subscription
      description: 'Get billing subscription state.


        Required scope: `billing:read`.


        On success, `data` contains: `customers`, `subscriptions`, `subscription`, `products`.'
      tags:
      - Billing
      security:
      - bearerAuth:
        - billing:read
      x-sitegpt-auth: bearer
      x-sitegpt-scopes:
      - billing:read
      x-mint:
        title: Get subscription
        description: Get billing subscription state.
      responses:
        '200':
          description: Successful SiteGPT API v2 response.
          content:
            application/json:
              schema:
                type: object
                required:
                - ok
                - data
                - meta
                properties:
                  ok:
                    type: boolean
                    const: true
                  data:
                    type: object
                    additionalProperties: true
                    properties:
                      customers:
                        type: array
                        items:
                          $ref: '#/components/schemas/BillingCustomer'
                      subscriptions:
                        type: array
                        items:
                          anyOf:
                          - $ref: '#/components/schemas/BillingSubscription'
                          - type: 'null'
                      subscription:
                        anyOf:
                        - $ref: '#/components/schemas/BillingSubscription'
                        - type: 'null'
                      products:
                        type: object
                        additionalProperties: false
                        properties:
                          sitegpt:
                            anyOf:
                            - $ref: '#/components/schemas/BillingProduct'
                            - type: 'null'
                          watermarkAddon:
                            anyOf:
                            - $ref: '#/components/schemas/BillingProduct'
                            - type: 'null'
                          extraMessagesAddon:
                            anyOf:
                            - $ref: '#/components/schemas/BillingProduct'
                            - type: 'null'
                          webhookAddon:
                            anyOf:
                            - $ref: '#/components/schemas/BillingProduct'
                            - type: 'null'
                          whatsappAddon:
                            anyOf:
                            - $ref: '#/components/schemas/BillingProduct'
                            - type: 'null'
                          emailAddon:
                            anyOf:
                            - $ref: '#/components/schemas/BillingProduct'
                            - type: 'null'
                  meta:
                    $ref: '#/components/schemas/AgentResponseMeta'
                additionalProperties: false
              example:
                ok: true
                data:
                  customers:
                  - id: ctm_x
                    email: user@example.com
                    status: active
                  subscriptions:
                  - id: sub_x
                    status: active
                  subscription:
                    id: sub_x
                    status: active
                  products:
                    sitegpt:
                      productId: pro_x
                      pricingName: Growth
                      interval: month
                    watermarkAddon: null
                    extraMessagesAddon: null
                    webhookAddon: null
                    whatsappAddon: null
                    emailAddon: null
                meta:
                  requestId: request-id
        '400':
          $ref: '#/components/responses/AgentError'
        '401':
          $ref: '#/components/responses/AgentError'
        '403':
          $ref: '#/components/responses/AgentError'
        '404':
          $ref: '#/components/responses/AgentError'
        '405':
          $ref: '#/components/responses/AgentError'
  /api/v2/billing/invoices:
    get:
      operationId: listBillingInvoices
      summary: List invoices
      description: 'List billing invoices and transaction download links.


        Required scope: `billing:read`.


        On success, `data` contains: `invoices`.'
      tags:
      - Billing
      security:
      - bearerAuth:
        - billing:read
      x-sitegpt-auth: bearer
      x-sitegpt-scopes:
      - billing:read
      x-mint:
        title: List invoices
        description: List billing invoices and transaction download links.
      responses:
        '200':
          description: Successful SiteGPT API v2 response.
          content:
            application/json:
              schema:
                type: object
                required:
                - ok
                - data
                - meta
                properties:
                  ok:
                    type: boolean
                    const: true
                  data:
                    type: object
                    additionalProperties: true
                    properties:
                      invoices:
                        type: array
                        items:
                          $ref: '#/components/schemas/Invoice'
                  meta:
                    $ref: '#/components/schemas/AgentResponseMeta'
                additionalProperties: false
              example:
                ok: true
                data:
                  invoices:
                  - id: txn_x
                    status: completed
                    amount: '4900'
                    currencyCode: USD
                    downloadUrl: https://example.com/invoice.pdf
                meta:
                  requestId: request-id
        '400':
          $ref: '#/components/responses/AgentError'
        '401':
          $ref: '#/components/responses/AgentError'
        '403':
          $ref: '#/components/responses/AgentError'
        '404':
          $ref: '#/components/responses/AgentError'
        '405':
          $ref: '#/components/responses/AgentError'
components:
  schemas:
    GenericObject:
      type: object
      additionalProperties: true
    BillingCustomer:
      type: object
      description: A Paddle billing customer linked to this account.
      additionalProperties: true
      properties:
        id:
          type: string
        email:
          type: string
        name:
          type:
          - string
          - 'null'
        status:
          type: string
        createdAt:
          type: string
          format: date-time
        updatedAt:
          type: string
          format: date-time
    AgentError:
      type: object
      required:
      - ok
      - error
      - meta
      properties:
        ok:
          type: boolean
          const: false
        error:
          type: object
          required:
          - code
          - message
          properties:
            code:
              type: string
            message:
              type: string
            details: {}
          additionalProperties: false
        meta:
          type: object
          required:
          - requestId
          properties:
            requestId:
              type: string
          additionalProperties: true
      additionalProperties: false
    Invoice:
      type: object
      description: A billing transaction with its invoice download link.
      additionalProperties: true
      properties:
        id:
          type: string
        status:
          type: string
        subscriptionStatus:
          type:
          - string
          - 'null'
        customerId:
          type: string
        subscriptionId:
          type:
          - string
          - 'null'
        invoiceId:
          type:
          - string
          - 'null'
        invoiceNumber:
          type:
          - string
          - 'null'
        currencyCode:
          type: string
        amount:
          type:
          - string
          - 'null'
        amountFormatted:
          type:
          - string
          - 'null'
        origin:
          type: string
        collectionMode:
          type: string
        billingPeriod:
          $ref: '#/components/schemas/GenericObject'
          description: Billing period start and end.
        billedAt:
          type:
          - string
          - 'null'
          format: date-time
        paidAt:
          type:
          - string
          - 'null'
          format: date-time
        createdAt:
          type: string
          format: date-time
        updatedAt:
          type: string
          format: date-time
        downloadUrl:
          type:
          - string
          - 'null'
          description: PDF invoice download URL, when available.
        paymentMethod:
          type:
          - string
          - 'null'
        products:
          type: array
          items:
            $ref: '#/components/schemas/GenericObject'
            description: Purchased product line item.
    AgentResponseMeta:
      type: object
      required:
      - requestId
      properties:
        requestId:
          type: string
        warnings:
          type: array
          items:
            type: string
        nextCursor:
          type:
          - string
          - 'null'
      additionalProperties: true
    BillingProduct:
      type: object
      description: One active subscription line item.
      additionalProperties: true
      properties:
        productId:
          type: string
        pricingName:
          type: string
        interval:
          type: string
        amount:
          type: string
        currencyCode:
          type: string
        quantity:
          type: integer
        nextBilledAt:
          type:
          - string
          - 'null'
          format: date-time
    BillingSubscription:
      type: object
      description: A Paddle subscription as serialized for the agent API.
      additionalProperties: true
      properties:
        id:
          type: string
        status:
          type: string
        customerId:
          type: string
        currencyCode:
          type: string
        collectionMode:
          type: string
        createdAt:
          type: string
          format: date-time
        updatedAt:
          type: string
          format: date-time
        startedAt:
          type:
          - string
          - 'null'
          format: date-time
        firstBilledAt:
          type:
          - string
          - 'null'
          format: date-time
        nextBilledAt:
          type:
          - string
          - 'null'
          format: date-time
        pausedAt:
          type:
          - string
          - 'null'
          format: date-time
        canceledAt:
          type:
          - string
          - 'null'
          format: date-time
        currentBillingPeriod:
          anyOf:
          - $ref: '#/components/schemas/GenericObject'
            description: Current billing period start and end; null between periods.
          - type: 'null'
        billingCycle:
          $ref: '#/components/schemas/GenericObject'
          description: Billing interval and frequency.
        scheduledChange:
          anyOf:
          - $ref: '#/components/schemas/GenericObject'
            description: Scheduled pause, cancel, or resume; null when nothing is scheduled.
          - type: 'null'
        managementUrls:
          $ref: '#/components/schemas/GenericObject'
          description: Paddle-hosted management URLs for this subscription.
  responses:
    AgentError:
      description: SiteGPT agent API error response.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/AgentError'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: SiteGPT API token