{
  "$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"
    }
  }
}