Kong · Schema

UpsertCustomerBillingDataRequest

CustomerBillingData upsert request.

API GatewayAI GatewayAI ConnectivityAgent GatewayEvent GatewayMCP RegistryService MeshLLMKafkaKonnectOpen Source

Properties

Name Type Description
billing_profile object The billing profile for the customer. If not provided, the default billing profile will be used.
app_data object App customer data.
View JSON Schema on GitHub

JSON Schema

kong-upsertcustomerbillingdatarequest-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/UpsertCustomerBillingDataRequest",
  "title": "UpsertCustomerBillingDataRequest",
  "description": "CustomerBillingData upsert request.",
  "type": "object",
  "properties": {
    "billing_profile": {
      "description": "The billing profile for the customer.\n\nIf not provided, the default billing profile will be used.",
      "type": "object",
      "properties": {
        "id": {
          "description": "The ID of the billing profile.",
          "type": "string",
          "example": "01G65Z755AFWAKHE12NY0CQ9FH",
          "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$",
          "title": "ULID"
        }
      },
      "required": [
        "id"
      ],
      "title": "Billing profile"
    },
    "app_data": {
      "description": "App customer data.",
      "type": "object",
      "properties": {
        "stripe": {
          "description": "Used if the customer has a linked Stripe app.",
          "type": "object",
          "properties": {
            "customer_id": {
              "description": "The Stripe customer ID used.",
              "type": "string",
              "example": "cus_1234567890",
              "title": "Stripe customer ID"
            },
            "default_payment_method_id": {
              "description": "The Stripe default payment method ID.",
              "type": "string",
              "example": "pm_1234567890",
              "title": "Stripe default payment method ID"
            },
            "labels": {
              "description": "Labels for this Stripe integration on the customer.",
              "type": "object",
              "example": {
                "env": "test"
              },
              "additionalProperties": {
                "type": "string",
                "pattern": "^[a-z0-9A-Z]{1}([a-z0-9A-Z-._]*[a-z0-9A-Z]+)?$",
                "minLength": 1,
                "maxLength": 63
              },
              "maxProperties": 50,
              "title": "Labels"
            }
          },
          "title": "Stripe"
        },
        "external_invoicing": {
          "description": "Used if the customer has a linked external invoicing app.",
          "type": "object",
          "properties": {
            "labels": {
              "description": "Labels for this external invoicing integration on the customer.",
              "type": "object",
              "example": {
                "env": "test"
              },
              "additionalProperties": {
                "type": "string",
                "pattern": "^[a-z0-9A-Z]{1}([a-z0-9A-Z-._]*[a-z0-9A-Z]+)?$",
                "minLength": 1,
                "maxLength": 63
              },
              "maxProperties": 50,
              "title": "Labels"
            }
          },
          "title": "External invoicing"
        }
      },
      "title": "App customer data"
    }
  }
}