Kong · Schema

BillingCustomer

Customers can be individuals or organizations that can subscribe to plans and have access to features.

API GatewayAI GatewayAI ConnectivityAgent GatewayEvent GatewayMCP RegistryService MeshLLMKafkaKonnectOpen Source

Properties

Name	Type	Description
id	string	ULID (Universally Unique Lexicographically Sortable Identifier).
name	string	Display name of the resource. Between 1 and 256 characters.
description	string	Optional description of the resource. Maximum 1024 characters.
labels	object
created_at	string	An ISO-8601 timestamp representation of entity creation date.
updated_at	string	An ISO-8601 timestamp representation of entity last update date.
deleted_at	string	An ISO-8601 timestamp representation of entity deletion date.
key	object
usage_attribution	object	Mapping to attribute metered usage to the customer by the event subject.
primary_email	string	The primary email address of the customer.
currency	string	Currency of the customer. Used for billing, tax and invoicing.
billing_address	object	The billing address of the customer. Used for tax and invoicing.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/BillingCustomer",
  "title": "BillingCustomer",
  "description": "Customers can be individuals or organizations that can subscribe to plans and have access to features.",
  "type": "object",
  "properties": {
    "id": {
      "description": "ULID (Universally Unique Lexicographically Sortable Identifier).",
      "type": "string",
      "example": "01G65Z755AFWAKHE12NY0CQ9FH",
      "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$",
      "readOnly": true,
      "title": "ULID"
    },
    "name": {
      "description": "Display name of the resource.\n\nBetween 1 and 256 characters.",
      "type": "string",
      "maxLength": 256,
      "minLength": 1
    },
    "description": {
      "description": "Optional description of the resource.\n\nMaximum 1024 characters.",
      "type": "string",
      "maxLength": 1024
    },
    "labels": {
      "$ref": "#/components/schemas/Labels"
    },
    "created_at": {
      "description": "An ISO-8601 timestamp representation of entity creation date.",
      "type": "string",
      "format": "date-time",
      "example": "2023-01-01T01:01:01.001Z",
      "readOnly": true,
      "title": "RFC3339 Date-Time"
    },
    "updated_at": {
      "description": "An ISO-8601 timestamp representation of entity last update date.",
      "type": "string",
      "format": "date-time",
      "example": "2023-01-01T01:01:01.001Z",
      "readOnly": true,
      "title": "RFC3339 Date-Time"
    },
    "deleted_at": {
      "description": "An ISO-8601 timestamp representation of entity deletion date.",
      "type": "string",
      "format": "date-time",
      "example": "2023-01-01T01:01:01.001Z",
      "readOnly": true,
      "title": "RFC3339 Date-Time"
    },
    "key": {
      "$ref": "#/components/schemas/ExternalResourceKey"
    },
    "usage_attribution": {
      "description": "Mapping to attribute metered usage to the customer by the event subject.",
      "type": "object",
      "properties": {
        "subject_keys": {
          "description": "The subjects that are attributed to the customer.\nCan be empty when no usage event subjects are associated with the customer.",
          "type": "array",
          "items": {
            "$ref": "#/components/schemas/UsageAttributionSubjectKey"
          },
          "minItems": 0,
          "title": "Subject Keys"
        }
      },
      "required": [
        "subject_keys"
      ],
      "title": "Usage Attribution"
    },
    "primary_email": {
      "description": "The primary email address of the customer.",
      "type": "string",
      "title": "Primary Email"
    },
    "currency": {
      "description": "Currency of the customer.\nUsed for billing, tax and invoicing.",
      "type": "string",
      "example": "USD",
      "maxLength": 3,
      "minLength": 3,
      "pattern": "^[A-Z]{3}$",
      "title": "Currency"
    },
    "billing_address": {
      "description": "The billing address of the customer.\nUsed for tax and invoicing.",
      "type": "object",
      "properties": {
        "country": {
          "description": "Country code in [ISO 3166-1](https://www.iso.org/iso-3166-country-codes.html) alpha-2 format.",
          "type": "string",
          "example": "US",
          "maxLength": 2,
          "minLength": 2,
          "pattern": "^[A-Z]{2}$",
          "title": "Country"
        },
        "postal_code": {
          "description": "Postal code.",
          "type": "string",
          "title": "Postal Code"
        },
        "state": {
          "description": "State or province.",
          "type": "string",
          "title": "State"
        },
        "city": {
          "description": "City.",
          "type": "string",
          "title": "City"
        },
        "line1": {
          "description": "First line of the address.",
          "type": "string",
          "title": "Line 1"
        },
        "line2": {
          "description": "Second line of the address.",
          "type": "string",
          "title": "Line 2"
        },
        "phone_number": {
          "description": "Phone number.",
          "type": "string",
          "title": "Phone Number"
        }
      },
      "title": "Billing Address"
    }
  },
  "required": [
    "id",
    "name",
    "created_at",
    "updated_at",
    "key"
  ]
}