planetscale · Schema

Invoice

A billing invoice for an organization.

Properties

Name	Type	Description
id	string	The unique identifier of the invoice.
period_start	string	The start date of the billing period.
period_end	string	The end date of the billing period.
total	number	The total invoice amount in cents.
currency	string	The currency code for the invoice.
status	string	The payment status of the invoice.
created_at	string	The timestamp when the invoice was generated.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/Invoice",
  "title": "Invoice",
  "type": "object",
  "description": "A billing invoice for an organization.",
  "properties": {
    "id": {
      "type": "string",
      "description": "The unique identifier of the invoice."
    },
    "period_start": {
      "type": "string",
      "format": "date",
      "description": "The start date of the billing period."
    },
    "period_end": {
      "type": "string",
      "format": "date",
      "description": "The end date of the billing period."
    },
    "total": {
      "type": "number",
      "description": "The total invoice amount in cents."
    },
    "currency": {
      "type": "string",
      "description": "The currency code for the invoice."
    },
    "status": {
      "type": "string",
      "description": "The payment status of the invoice.",
      "enum": [
        "draft",
        "open",
        "paid",
        "void"
      ]
    },
    "created_at": {
      "type": "string",
      "format": "date-time",
      "description": "The timestamp when the invoice was generated."
    }
  }
}