AgentaOS · Schema

SubscriptionInvoice

One cycle's invoice on a subscription's billing history. Fully camelCase on the wire.

PaymentsBillingSoftware-as-a-ServiceFreelancersArtificial Intelligence

Properties

Name Type Description
id string
invoiceNumber string
status string
issuedAt string
amount number The settled amount for this cycle: the linked capture's settlement earnings (net + fee + vat) when one is available in the invoice's own fiat currency, else the merchant's fiat_amount, else the settle
currency string
disputed boolean Derived from the linked capture's dispute state, never persisted — reverts to false the instant a won dispute restores the capture. Only ever true when status is 'paid'.
View JSON Schema on GitHub

JSON Schema

agentaos-ai-subscription-invoice-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/agentaos-ai/json-schema/agentaos-ai-subscription-invoice-schema.json",
  "title": "SubscriptionInvoice",
  "description": "One cycle's invoice on a subscription's billing history. Fully camelCase on the wire.",
  "x-generated": "2026-11-04",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/agentaos-ai-subscriptions-api-openapi.yml#/components/schemas/SubscriptionInvoice",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "format": "uuid"
    },
    "invoiceNumber": {
      "type": "string"
    },
    "status": {
      "type": "string",
      "enum": [
        "issued",
        "paid",
        "voided"
      ]
    },
    "issuedAt": {
      "type": "string",
      "format": "date-time"
    },
    "amount": {
      "type": "number",
      "description": "The settled amount for this cycle: the linked capture's settlement earnings (net + fee + vat) when one is available in the invoice's own fiat currency, else the merchant's fiat_amount, else the settlement-token amount. Already resolved server-side — never recompute this."
    },
    "currency": {
      "type": "string"
    },
    "disputed": {
      "type": "boolean",
      "description": "Derived from the linked capture's dispute state, never persisted — reverts to false the instant a won dispute restores the capture. Only ever true when status is 'paid'."
    }
  },
  "required": [
    "id",
    "invoiceNumber",
    "status",
    "issuedAt",
    "amount",
    "currency",
    "disputed"
  ]
}

Work with this as data

Every JSON Schema 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 schemas

4 MCP tools reach this
  • find_json_schemasBrowse and filter every JSON Schema in the catalog.
  • 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 JSON Schema
curl "https://apis.io/api/v1/json-schemas/agentaos-ai-subscription-invoice"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

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.

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