Orsun Pay · Schema

UsageSubscriptionDetailResponseDto

PaymentsPayment OrchestrationCheckoutPayment LinksMerchant CabinetiGamingCrypto PaymentsDonations

Properties

Name	Type	Description
autoRenewEnabled	boolean
cancelAtPeriodEnd	boolean
createdAt	string
currency	string
customerRef	string
events	array
id	string
includedCredits	string
invoices	array
monthlyPrice	string
notificationEmailConfigured	boolean
notificationEnabled	boolean
notificationLocale	string
overageAmount	string
overageCredits	string
overageLimit	string
overageUnitPrice	string
paymentState	string	Payment state; unknown cannot be retried as a new payment.
periodEnd	object
periodStart	object
planId	string
planName	string
remainingCredits	string
status	string
unit	string
usedCredits	string

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/orsunpay-com/json-schema/orsunpay-com-usage-subscription-detail-response-dto-schema.json",
  "title": "UsageSubscriptionDetailResponseDto",
  "x-generated": "2026-11-06",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/orsunpay-com-openapi.json#/components/schemas/UsageSubscriptionDetailResponseDto",
  "properties": {
    "autoRenewEnabled": {
      "type": "boolean"
    },
    "cancelAtPeriodEnd": {
      "type": "boolean"
    },
    "createdAt": {
      "format": "date-time",
      "type": "string"
    },
    "currency": {
      "type": "string"
    },
    "customerRef": {
      "type": "string"
    },
    "events": {
      "items": {
        "$ref": "#/$defs/UsageEventResponseDto"
      },
      "type": "array"
    },
    "id": {
      "type": "string"
    },
    "includedCredits": {
      "type": "string"
    },
    "invoices": {
      "items": {
        "$ref": "#/$defs/UsageInvoiceResponseDto"
      },
      "type": "array"
    },
    "monthlyPrice": {
      "pattern": "^(0|[1-9]\\d{0,19})(\\.\\d{1,18})?$",
      "type": "string"
    },
    "notificationEmailConfigured": {
      "type": "boolean"
    },
    "notificationEnabled": {
      "type": "boolean"
    },
    "notificationLocale": {
      "enum": [
        "en",
        "uk"
      ],
      "type": "string"
    },
    "overageAmount": {
      "pattern": "^(0|[1-9]\\d{0,19})(\\.\\d{1,18})?$",
      "type": "string"
    },
    "overageCredits": {
      "type": "string"
    },
    "overageLimit": {
      "pattern": "^(0|[1-9]\\d{0,19})(\\.\\d{1,18})?$",
      "type": "string"
    },
    "overageUnitPrice": {
      "pattern": "^(0|[1-9]\\d{0,19})(\\.\\d{1,18})?$",
      "type": "string"
    },
    "paymentState": {
      "description": "Payment state; unknown cannot be retried as a new payment.",
      "type": "string"
    },
    "periodEnd": {
      "anyOf": [
        {
          "format": "date-time",
          "type": "string"
        },
        {
          "type": "null"
        }
      ]
    },
    "periodStart": {
      "anyOf": [
        {
          "format": "date-time",
          "type": "string"
        },
        {
          "type": "null"
        }
      ]
    },
    "planId": {
      "type": "string"
    },
    "planName": {
      "type": "string"
    },
    "remainingCredits": {
      "type": "string"
    },
    "status": {
      "enum": [
        "pending_payment",
        "active",
        "past_due",
        "cancelled"
      ],
      "type": "string"
    },
    "unit": {
      "type": "string"
    },
    "usedCredits": {
      "type": "string"
    }
  },
  "required": [
    "id",
    "planId",
    "customerRef",
    "status",
    "planName",
    "unit",
    "currency",
    "monthlyPrice",
    "includedCredits",
    "overageUnitPrice",
    "overageLimit",
    "periodStart",
    "periodEnd",
    "usedCredits",
    "remainingCredits",
    "overageCredits",
    "overageAmount",
    "cancelAtPeriodEnd",
    "autoRenewEnabled",
    "paymentState",
    "notificationEnabled",
    "notificationEmailConfigured",
    "notificationLocale",
    "createdAt",
    "events",
    "invoices"
  ],
  "type": "object",
  "$defs": {
    "UsageEventResponseDto": {
      "properties": {
        "createdAt": {
          "format": "date-time",
          "type": "string"
        },
        "credits": {
          "type": "string"
        },
        "eventId": {
          "type": "string"
        },
        "id": {
          "type": "string"
        },
        "subscriptionId": {
          "type": "string"
        }
      },
      "required": [
        "id",
        "eventId",
        "subscriptionId",
        "credits",
        "createdAt"
      ],
      "type": "object"
    },
    "UsageInvoiceResponseDto": {
      "properties": {
        "baseAmount": {
          "pattern": "^(0|[1-9]\\d{0,19})(\\.\\d{1,18})?$",
          "type": "string"
        },
        "createdAt": {
          "format": "date-time",
          "type": "string"
        },
        "currency": {
          "type": "string"
        },
        "id": {
          "type": "string"
        },
        "kind": {
          "enum": [
            "initial",
            "renewal",
            "final"
          ],
          "type": "string"
        },
        "overageAmount": {
          "pattern": "^(0|[1-9]\\d{0,19})(\\.\\d{1,18})?$",
          "type": "string"
        },
        "paidAt": {
          "anyOf": [
            {
              "format": "date-time",
              "type": "string"
            },
            {
              "type": "null"
            }
          ]
        },
        "paymentUrl": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ]
        },
        "periodEnd": {
          "format": "date-time",
          "type": "string"
        },
        "periodStart": {
          "format": "date-time",
          "type": "string"
        },
        "status": {
          "enum": [
            "open",
            "paid",
            "void"
          ],
          "type": "string"
        },
        "subscriptionId": {
          "type": "string"
        },
        "totalAmount": {
          "pattern": "^(0|[1-9]\\d{0,19})(\\.\\d{1,18})?$",
          "type": "string"
        }
      },
      "required": [
        "id",
        "subscriptionId",
        "kind",
        "status",
        "currency",
        "baseAmount",
        "overageAmount",
        "totalAmount",
        "periodStart",
        "periodEnd",
        "paymentUrl",
        "createdAt",
        "paidAt"
      ],
      "type": "object"
    }
  }
}

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/orsunpay-com-usage-subscription-detail-response-dto"

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.

GitHub Google LinkedIn

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