Amberflo · JSON Structure

Billing Customer Structure

A customer account in Amberflo

Type: object Properties: 13 Required: 2
Usage-Based BillingMeteringFinOpsAI Cost ManagementBillingMonetization

Customer is a JSON Structure definition published by Amberflo, describing 13 properties, of which 2 are required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

createTime updateTime deleteTime customerId customerName customerEmail description enabled test lifecycleStage deactivateTimeStamp traits address

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amberflo/refs/heads/main/json-structure/billing-customer-structure.json",
  "name": "Customer",
  "description": "A customer account in Amberflo",
  "type": "object",
  "properties": {
    "createTime": {
      "type": "int64",
      "description": "Creation timestamp in Unix milliseconds",
      "example": 1718153645993
    },
    "updateTime": {
      "type": "int64",
      "description": "Last update timestamp in Unix milliseconds",
      "example": 1718153645993
    },
    "deleteTime": {
      "type": "int64",
      "description": "Deletion timestamp in Unix milliseconds",
      "example": 1718153645993
    },
    "customerId": {
      "type": "string",
      "description": "Unique customer identifier from your system",
      "example": "customer-123456"
    },
    "customerName": {
      "type": "string",
      "description": "Customer display name",
      "example": "Acme Corp"
    },
    "customerEmail": {
      "type": "string",
      "format": "email",
      "description": "Customer contact email",
      "example": "billing@acme.com"
    },
    "description": {
      "type": "string",
      "description": "Customer description",
      "example": "Enterprise customer account for Acme Corporation"
    },
    "enabled": {
      "type": "boolean",
      "description": "Deprecated \u2014 use lifecycleStage instead",
      "deprecated": true
    },
    "test": {
      "type": "boolean",
      "description": "Whether this is a test customer account",
      "example": false
    },
    "lifecycleStage": {
      "type": "string",
      "description": "Customer lifecycle stage",
      "enum": [
        "ONBOARDING",
        "TRAIL",
        "ACTIVE",
        "OFFBOARDED"
      ],
      "example": "ACTIVE"
    },
    "deactivateTimeStamp": {
      "type": "int64",
      "description": "Last deactivation timestamp in Unix milliseconds"
    },
    "traits": {
      "type": "object",
      "additionalProperties": {
        "type": "string"
      },
      "description": "Custom metadata for external system integration"
    },
    "address": {
      "$ref": "#/components/schemas/Address"
    }
  },
  "required": [
    "customerId",
    "customerName"
  ]
}