TM Forum · JSON Structure

Tmf622 Product Ordering Order Price Structure

OrderPrice schema from TM Forum API

Type: Properties: 0
TelcoTelecommunicationsBSSOSSOpen APIsStandards

OrderPrice is a JSON Structure definition published by TM Forum. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

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/tm-forum/refs/heads/main/json-structure/tmf622-product-ordering-order-price-structure.json",
  "name": "OrderPrice",
  "description": "OrderPrice schema from TM Forum API",
  "allOf": [
    {
      "$ref": "#/components/schemas/Extensible"
    },
    {
      "type": "object",
      "description": "An amount, usually of money, that represents the actual price paid by the Customer for this item or this order",
      "properties": {
        "description": {
          "type": "string",
          "description": "A narrative that explains in detail the semantics of this order item price."
        },
        "name": {
          "type": "string",
          "description": "A short descriptive name such as \"Subscription price\"."
        },
        "productOfferingPrice": {
          "$ref": "#/components/schemas/ProductOfferingPriceRef"
        },
        "recurringChargePeriod": {
          "type": "string",
          "description": "Could be month, week..."
        },
        "unitOfMeasure": {
          "type": "string",
          "description": "Could be minutes, GB..."
        },
        "billingAccount": {
          "$ref": "#/components/schemas/BillingAccountRef"
        },
        "priceAlteration": {
          "type": "array",
          "description": "a strucuture used to describe a price alteration",
          "items": {
            "$ref": "#/components/schemas/PriceAlteration"
          }
        },
        "price": {
          "$ref": "#/components/schemas/Price"
        },
        "priceType": {
          "type": "string",
          "description": "indicate if the price is for recurrent or no-recurrent charge"
        }
      }
    }
  ],
  "discriminator": {
    "propertyName": "@type",
    "mapping": {
      "OrderPrice": "#/components/schemas/OrderPrice"
    }
  }
}