Amberflo · Schema

CustomerRequest

Request body for creating or updating a customer

Usage-Based BillingMeteringFinOpsAI Cost ManagementBillingMonetization

Properties

Name Type Description
customerId string Unique customer identifier
customerName string Customer display name
customerEmail string Customer email address
description string Customer description
test boolean Marks customer as test
lifecycleStage string Lifecycle stage
traits object Custom metadata
address object
View JSON Schema on GitHub

JSON Schema

billing-customer-request-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amberflo/refs/heads/main/json-schema/billing-customer-request-schema.json",
  "title": "CustomerRequest",
  "description": "Request body for creating or updating a customer",
  "type": "object",
  "properties": {
    "customerId": {
      "type": "string",
      "description": "Unique customer identifier",
      "example": "customer-123456"
    },
    "customerName": {
      "type": "string",
      "description": "Customer display name",
      "example": "Acme Corp"
    },
    "customerEmail": {
      "type": "string",
      "format": "email",
      "description": "Customer email address",
      "example": "[email protected]"
    },
    "description": {
      "type": "string",
      "description": "Customer description"
    },
    "test": {
      "type": "boolean",
      "description": "Marks customer as test",
      "example": false
    },
    "lifecycleStage": {
      "type": "string",
      "description": "Lifecycle stage",
      "enum": [
        "ONBOARDING",
        "TRAIL",
        "ACTIVE",
        "OFFBOARDED"
      ],
      "example": "ACTIVE"
    },
    "traits": {
      "type": "object",
      "additionalProperties": {
        "type": "string"
      },
      "description": "Custom metadata"
    },
    "address": {
      "$ref": "#/components/schemas/Address"
    }
  },
  "required": [
    "customerId",
    "customerName"
  ]
}