---
title: "BillingCurrency"
url: "https://nov18-dev.movespot.fyi/apis/konnect-metering-billing-private-0/versions/6e18e75c-446e-4fe4-8c39-2ccdd58e22a9/schemas/BillingCurrency"
---

> Full API specification: https://nov18-dev.movespot.fyi/apis/konnect-metering-billing-private-0/versions/6e18e75c-446e-4fe4-8c39-2ccdd58e22a9.md

# BillingCurrency

Fiat or custom currency.

## 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:
    BillingCurrencyFiat:
      description: Currency describes a currency supported by the billing system.
      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
        type:
          description: The type of the currency.
          type: string
          enum:
            - fiat
          readOnly: true
        name:
          description: The name of the currency. It should be a human-readable string that
            represents the name of the currency, such as "US Dollar" or "Euro".
          type: string
          maxLength: 256
          minLength: 1
        description:
          description: Description of the currency.
          type: string
          maxLength: 256
          minLength: 1
        symbol:
          description: The symbol of the currency. It should be a string that represents
            the symbol of the currency, such as "$" for US Dollar or "€" for
            Euro.
          type: string
          minLength: 1
        code:
          description: >-
            Three-letter
            [ISO4217](https://www.iso.org/iso-4217-currency-codes.html) currency
            code.

            Custom three-letter currency codes are also supported for
            convenience.
          type: string
          example: USD
          maxLength: 3
          minLength: 3
          pattern: ^[A-Z]{3}$
          readOnly: true
      required:
        - id
        - type
        - name
        - code
    BillingCurrencyCustom:
      description: Describes custom currency.
      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
        type:
          description: The type of the currency.
          type: string
          enum:
            - custom
          readOnly: true
        name:
          description: The name of the currency. It should be a human-readable string that
            represents the name of the currency, such as "US Dollar" or "Euro".
          type: string
          maxLength: 256
          minLength: 1
        description:
          description: Description of the currency.
          type: string
          maxLength: 256
          minLength: 1
        symbol:
          description: The symbol of the currency. It should be a string that represents
            the symbol of the currency, such as "$" for US Dollar or "€" for
            Euro.
          type: string
          minLength: 1
        code:
          $ref: "#/components/schemas/BillingCurrencyCodeCustom"
        created_at:
          description: An ISO-8601 timestamp representation of the custom currency
            creation date.
          type: string
          format: date-time
          example: 2023-01-01T01:01:01.001Z
          readOnly: true
          title: RFC3339 Date-Time
      required:
        - id
        - type
        - name
        - code
    BillingCurrencyCodeCustom:
      description: >-
        Custom currency code.

        It should be a unique code but not conflicting with any existing fiat
        currency codes.
      type: string
      maxLength: 24
      minLength: 3
    BillingCurrency:
      description: Fiat or custom currency.
      type: object
      discriminator:
        propertyName: type
        mapping:
          fiat: "#/components/schemas/BillingCurrencyFiat"
          custom: "#/components/schemas/BillingCurrencyCustom"
      oneOf:
        - $ref: "#/components/schemas/BillingCurrencyFiat"
        - $ref: "#/components/schemas/BillingCurrencyCustom"
```
