---
title: "BillingCustomer"
url: "https://nov18-dev.movespot.fyi/apis/konnect-metering-billing-0/versions/1801ac42-b9c2-4bc2-8094-1177df9ed25c/schemas/BillingCustomer"
---

> Full API specification: https://nov18-dev.movespot.fyi/apis/konnect-metering-billing-0/versions/1801ac42-b9c2-4bc2-8094-1177df9ed25c.md

# BillingCustomer

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

## OpenAPI definition

```yaml
openapi: 3.0.0
info:
  title: Konnect Metering & Billing
  version: 0.0.1
servers:
  - url: https://us.api.konghq.com/v3
    description: United-States Production region
  - url: https://eu.api.konghq.com/v3
    description: Europe Production region
  - url: https://au.api.konghq.com/v3
    description: Australia Production region
  - url: https://me.api.konghq.com/v3
    description: Middle-East Production region
  - url: https://in.api.konghq.com/v3
    description: India Production region
  - url: https://sg.api.konghq.com/v3
    description: Singapore Production region
components:
  schemas:
    Labels:
      description: >
        Labels store metadata of an entity that can be used for filtering an
        entity list or for searching across entity types. 


        Keys must be of length 1-63 characters, and cannot start with "kong",
        "konnect", "mesh", "kic", or "_".
      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
    ExternalResourceKey:
      description: ExternalResourceKey is a unique string that is used to identify a
        resource in an external system.
      type: string
      example: 019ae40f-4258-7f15-9491-842f42a7d6ac
      maxLength: 256
      minLength: 1
      title: External Resource Key
    UsageAttributionSubjectKey:
      description: Subject key.
      type: string
      minLength: 1
    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.

            Between 1 and 256 characters.
          type: string
          maxLength: 256
          minLength: 1
        description:
          description: |-
            Optional description of the resource.

            Maximum 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.

                Can 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.
            Used 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.
            Used 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
        - key
```
