Jump to

• Request
• Response
• Examples

Get Price Models

get

/rest/v16/pricingSetup/models

Use this endpoint retrieve all price models.

Request

Query Parameters

• expand: string
  When this parameter is provided, the specified children are included in the resource payload (instead of just a link). More than one child can be specified using comma as a separator. Example: ?expand=priceModelItems,data. To include all the children and grandchildren, specify the value of this query parameter to be "all".
• fields: string
  This parameter filters the resource attributes. Only the specified attributes are returned, which means that if no attributes are specified, all attributes are returned.
• finder: string
  Used as a predefined finder to search the collection.
  Format: ?finder=<finderName>;<VarName>=<variableValue>
  The following are the available finder names and corresponding finder variables:

  • findByKeyword: Find pricing rules using name,VarName and description.
    Finder Variable:
    • keyword;string: The search text. The character '%' if present will be treated as a wild card otherwise, the default is 'contains' search

  • findLinkableModelsForRule: Find price models available for linking with pricing rule.This excludes any models that are already linked to the pricing rule.
    Finder Variable:
    • ruleVarName;string: The VarName of the rule.

  • findByRateCardVarName: Find price models linked to a given rate card.
    Finder Variable:
    • rateCardVarName;string: The VarName of the rate card

  • findModelsByTemplateVarName: Find price models linked to a given pricing matrix template.
    Finder Variable:
    • templateVarName;string: The VarName of the pricing matrix template.

  • findListTypeForModel: Find list type in price models.
    Finder Variable:
    • listTypeCode;string: The ListTypeCode, advanced, priceList or discountList
• limit: integer
  This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
• offset: integer
  Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).
• orderby: string
  This parameter orders a resource collection based on the specified attributes. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "ASC" or "DESC". Specify "ASC" for ascending and "DESC" for descending. The default value is "ASC". For example, ?orderby=field1:ASC,field2:DESC.
• totalResults: boolean
  The resource collection representation will include the total row count when "?totalResults=true", otherwise the count is not included. The default value is "false".

Back to Top

Response

Supported Media Types

• application/json

200 Response

Success

Body ()

Root Schema : PricingResourceCollection_PricingModel

Type: object

Show Source

• count: integer()
  Title: Count

  Read Only: true

  The number of resource instances returned in the current range.
• createdBy: Created By
  Title: Created By

  Read Only: true

  The details of the user who created the record.
• hasMore: boolean()
  Title: HasMore

  Read Only: true

  Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
• items: array items
• lastModifiedBy: Last Modified By
  Title: Last Modified By

  Read Only: true

  The details of the user who modified the record.
• limit: integer()
  Title: Limit

  Read Only: true

  The actual paging size used by the server.
• links: array Links
  Title: Links

  Read Only: true

  The link relations associated with the resource instance.
• offset: integer()
  Title: OffSet

  Read Only: true

  The offset value used in the current page.
• totalResults: integer()
  Title: Total Results

  Read Only: true

  Captures the total count of the resource instances, which not only includes the instances in the current range, but all instances on the server that satisfy the request.

{
    "properties":{
        "createdBy":{
            "format":"",
            "description":"The details of the user who created the record.",
            "title":"Created By",
            "readOnly":true,
            "allOf":[
                {
                    "$ref":"#/definitions/UserDetails"
                }
            ]
        },
        "lastModifiedBy":{
            "format":"",
            "description":"The details of the user who modified the record.",
            "title":"Last Modified By",
            "readOnly":true,
            "allOf":[
                {
                    "$ref":"#/definitions/UserDetails"
                }
            ]
        },
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/PricingModel"
            }
        },
        "offset":{
            "type":"integer",
            "format":"",
            "description":"The offset value used in the current page.",
            "title":"OffSet",
            "readOnly":true
        },
        "limit":{
            "type":"integer",
            "format":"",
            "description":"The actual paging size used by the server.",
            "title":"Limit",
            "readOnly":true
        },
        "count":{
            "type":"integer",
            "format":"",
            "description":"The number of resource instances returned in the current range.",
            "title":"Count",
            "readOnly":true
        },
        "totalResults":{
            "type":"integer",
            "format":"",
            "description":"Captures the total count of the resource instances, which not only includes the instances in the current range, but all instances on the server that satisfy the request.",
            "title":"Total Results",
            "readOnly":true
        },
        "hasMore":{
            "type":"boolean",
            "format":"",
            "description":"Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.",
            "title":"HasMore",
            "readOnly":true
        },
        "links":{
            "type":"array",
            "format":"",
            "description":"The link relations associated with the resource instance.",
            "title":"Links",
            "readOnly":true,
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    }
}

Nested Schema : Created By

Title: Created By

Read Only: true

The details of the user who created the record.

Match All

Show Source

• object UserDetails

{
    "format":"",
    "description":"The details of the user who created the record.",
    "title":"Created By",
    "readOnly":true,
    "allOf":[
        {
            "$ref":"#/definitions/UserDetails"
        }
    ]
}

Nested Schema : items

Type: array

Show Source

• Array of: object PricingModel

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/PricingModel"
    }
}

Nested Schema : Last Modified By

Title: Last Modified By

Read Only: true

The details of the user who modified the record.

Match All

Show Source

• object UserDetails

{
    "format":"",
    "description":"The details of the user who modified the record.",
    "title":"Last Modified By",
    "readOnly":true,
    "allOf":[
        {
            "$ref":"#/definitions/UserDetails"
        }
    ]
}

Nested Schema : Links

Type: array

Title: Links

Read Only: true

The link relations associated with the resource instance.

Show Source

• Array of: object Link

{
    "type":"array",
    "format":"",
    "description":"The link relations associated with the resource instance.",
    "title":"Links",
    "readOnly":true,
    "items":{
        "$ref":"#/definitions/Link"
    }
}

Nested Schema : UserDetails

Type: object

Show Source

• emailId: string()
  Title: Email Id

  Email Id of the user
• firstName: string()
  Title: First Name

  First Name of the user
• lastName: string()
  Title: Last Name

  Last Name of the user

{
    "properties":{
        "firstName":{
            "type":"string",
            "format":"",
            "description":"First Name of the user",
            "title":"First Name"
        },
        "lastName":{
            "type":"string",
            "format":"",
            "description":"Last Name of the user",
            "title":"Last Name"
        },
        "emailId":{
            "type":"string",
            "format":"",
            "description":"Email Id of the user",
            "title":"Email Id"
        }
    }
}

Nested Schema : PricingModel

Type: object

Show Source

• adjustmentType: string()
  Title: The Adjustment Type of price model

  Allowed Values: [ "discountPercent", "discountAmount", "markupPercent", "markupAmount" ]

  Adjustment Type.
• conditionType: string()
  Title: Condition Type

  Allowed Values: [ "alwaysTrue", "simple" ]

  The condition type of the Price Model.
• createdBy: Created By
  Title: Created By

  Read Only: true

  The details of the user who created the record.
• data: Model Data
  Title: Model Data

  Read Only: true

  List of data for the Price Model.
• dateAdded: string(yyyy-MM-dd'T'HH:mm:ss.SSS'Z')
  Title: Date Added

  Read Only: true

  Creation Date of the Price Model.
• dateModified: string(yyyy-MM-dd'T'HH:mm:ss.SSS'Z')
  Title: Date Modified

  Read Only: true

  Last Modified date of the Price Model.
• description: string()
  Title: Description

  Description of the pricing Model.
• dynamicPricingType: string()
  Title: Dynamic Pricing Type

  Allowed Values: [ "static", "advanced", "volume", "tiered", "rateCard", "attributeBasedCharge" ]

  The type of dynamic pricing applied by the Price Model.
• editRestriction: string()
  Title: Edit Restriction

  Read Only: true

  Allowed Values: [ "UNRESTRICTED", "ONLY_REORDERABLE", "RESTRICTED" ]

  Pricing Edit Restriction.
• endDate: string(yyyy-MM-dd'T'HH:mm:ss.SSS'Z')
  Title: End Date

  Effective End Date.
• hasBomItem: boolean()
  Title: Has BOM Item

  Read Only: true

  Indicates whether this model has prices defined for BOM Items.
• hasCharges: boolean()
  Title: Has Charges

  Read Only: true

  Indicates whether this Price Model has any charges.
• hasChargeSupport: boolean()
  Title: Has Charge Support

  Read Only: true

  Indicates whether this model has charge support.(Starting V16 this will be always true and will be deprecated)
• hasRateCards: boolean()
  Title: Has Rate Cards

  Read Only: true

  Indicates whether this model has any price model data that has linked rate cards. (Preview only)
• hasRatePlans: boolean()
  Title: Has Rate Plans

  Read Only: true

  Indicates whether this model has any price model data that has rate plans.
• hasTiers: boolean()
  Title: Has Tiers

  Read Only: true

  Indicates whether this model has any price model data that has tiers.
• integrationId: string()
  Title: Integration Id

  Price List ID from SCM.
• lastModifiedBy: Last Modified By
  Title: Last Modified By

  Read Only: true

  The details of the user who modified the record.
• links: array Links
  Title: Links

  Read Only: true

  The link relations associated with the resource instance.
• listType: string()
  Title: The List Type for the price model

  Allowed Values: [ "priceList", "discountList", "advanced", "markupList" ]

  List Type.
• matrixTemplateName: string()
  Title: Dynamic Matrix Template Name

  Read Only: true

  The dynamic matrix template name of the Price Model.
• matrixTemplateVariableName: string()
  Title: Dynamic Matrix Template Variable Name

  The dynamic matrix template variable name of the Price Model.
• name: string()
  Title: Name

  Name of the Price Model.
• priceModelItems: Model Items
  Title: Model Items

  Read Only: true

  List of model items for the Price Model.
• ruleCount: integer()
  Title: Linked Pricing Rules Count

  Read Only: true

  The count of pricing rules linked to this model.
• shared: boolean()
  Title: Shared

  Read Only: true

  Indicates whether this model is shared.
• simpleConditions: Simple Conditions
  Title: Simple Conditions

  A collection of simple Type conditions applied by the Price Model. This is optional for other condition type.
• startDate: string(yyyy-MM-dd'T'HH:mm:ss.SSS'Z')
  Title: Start Date

  Effective Start Date.
• supportedMatrixTemplateVariableName: string()
  Title: Supported Dynamic Matrix Pricing Template

  Read Only: true

  The supported dynamic matrix pricing template of the Price Model.
• valueType: string()
  Title: Value Type

  Allowed Values: [ "absolutePrice", "discountAmount", "discountPercent", "markupAmount", "markupPercent" ]

  The value type of Price Model.
• variableName: string()
  Title: Variable Name

  Unique Variable Name of the Price Model.

{
    "properties":{
        "createdBy":{
            "format":"",
            "description":"The details of the user who created the record.",
            "title":"Created By",
            "readOnly":true,
            "allOf":[
                {
                    "$ref":"#/definitions/UserDetails"
                }
            ]
        },
        "lastModifiedBy":{
            "format":"",
            "description":"The details of the user who modified the record.",
            "title":"Last Modified By",
            "readOnly":true,
            "allOf":[
                {
                    "$ref":"#/definitions/UserDetails"
                }
            ]
        },
        "dateModified":{
            "type":"string",
            "format":"yyyy-MM-dd'T'HH:mm:ss.SSS'Z'",
            "description":"Last Modified date of the Price Model.",
            "title":"Date Modified",
            "readOnly":true
        },
        "dateAdded":{
            "type":"string",
            "format":"yyyy-MM-dd'T'HH:mm:ss.SSS'Z'",
            "description":"Creation Date of the Price Model.",
            "title":"Date Added",
            "readOnly":true
        },
        "name":{
            "type":"string",
            "format":"",
            "description":"Name of the Price Model.",
            "title":"Name"
        },
        "variableName":{
            "type":"string",
            "format":"",
            "description":"Unique Variable Name of the Price Model.",
            "title":"Variable Name"
        },
        "description":{
            "type":"string",
            "format":"",
            "description":"Description of the pricing Model.",
            "title":"Description"
        },
        "conditionType":{
            "type":"string",
            "format":"",
            "description":"The condition type of the Price Model.",
            "title":"Condition Type",
            "enum":[
                "alwaysTrue",
                "simple"
            ]
        },
        "simpleConditions":{
            "format":"",
            "description":"A collection of simple Type conditions applied by the Price Model. This is optional for other condition type.",
            "title":"Simple Conditions",
            "allOf":[
                {
                    "$ref":"#/definitions/SimpleConditions"
                }
            ]
        },
        "shared":{
            "type":"boolean",
            "format":"",
            "description":"Indicates whether this model is shared.",
            "title":"Shared",
            "readOnly":true
        },
        "ruleCount":{
            "type":"integer",
            "format":"",
            "description":"The count of pricing rules linked to this model.",
            "title":"Linked Pricing Rules Count",
            "readOnly":true
        },
        "hasBomItem":{
            "type":"boolean",
            "format":"",
            "description":"Indicates whether this model has prices defined for BOM Items.",
            "title":"Has BOM Item",
            "readOnly":true
        },
        "hasRateCards":{
            "type":"boolean",
            "format":"",
            "description":"Indicates whether this model has any price model data that has linked rate cards. (Preview only)",
            "title":"Has Rate Cards",
            "readOnly":true
        },
        "startDate":{
            "type":"string",
            "format":"yyyy-MM-dd'T'HH:mm:ss.SSS'Z'",
            "description":"Effective Start Date.",
            "title":"Start Date"
        },
        "endDate":{
            "type":"string",
            "format":"yyyy-MM-dd'T'HH:mm:ss.SSS'Z'",
            "description":"Effective End Date.",
            "title":"End Date"
        },
        "integrationId":{
            "type":"string",
            "format":"",
            "description":"Price List ID from SCM.",
            "title":"Integration Id"
        },
        "data":{
            "format":"",
            "description":"List of data for the Price Model.",
            "title":"Model Data",
            "readOnly":true,
            "allOf":[
                {
                    "$ref":"#/definitions/PricingResourceCollection_PricingModelData"
                }
            ]
        },
        "links":{
            "type":"array",
            "format":"",
            "description":"The link relations associated with the resource instance.",
            "title":"Links",
            "readOnly":true,
            "items":{
                "$ref":"#/definitions/Link"
            }
        },
        "valueType":{
            "type":"string",
            "format":"",
            "description":"The value type of Price Model.",
            "title":"Value Type",
            "enum":[
                "absolutePrice",
                "discountAmount",
                "discountPercent",
                "markupAmount",
                "markupPercent"
            ]
        },
        "dynamicPricingType":{
            "type":"string",
            "format":"",
            "description":"The type of dynamic pricing applied by the Price Model.",
            "title":"Dynamic Pricing Type",
            "enum":[
                "static",
                "advanced",
                "volume",
                "tiered",
                "rateCard",
                "attributeBasedCharge"
            ]
        },
        "hasChargeSupport":{
            "type":"boolean",
            "format":"",
            "description":"Indicates whether this model has charge support.(Starting V16 this will be always true and will be deprecated)",
            "title":"Has Charge Support",
            "readOnly":true
        },
        "hasRatePlans":{
            "type":"boolean",
            "format":"",
            "description":"Indicates whether this model has any price model data that has rate plans.",
            "title":"Has Rate Plans",
            "readOnly":true
        },
        "hasTiers":{
            "type":"boolean",
            "format":"",
            "description":"Indicates whether this model has any price model data that has tiers.",
            "title":"Has Tiers",
            "readOnly":true
        },
        "matrixTemplateVariableName":{
            "type":"string",
            "format":"",
            "description":"The dynamic matrix template variable name of the Price Model.",
            "title":"Dynamic Matrix Template Variable Name"
        },
        "matrixTemplateName":{
            "type":"string",
            "format":"",
            "description":"The dynamic matrix template name of the Price Model.",
            "title":"Dynamic Matrix Template Name",
            "readOnly":true
        },
        "hasCharges":{
            "type":"boolean",
            "format":"",
            "description":"Indicates whether this Price Model has any charges.",
            "title":"Has Charges",
            "readOnly":true
        },
        "supportedMatrixTemplateVariableName":{
            "type":"string",
            "format":"",
            "description":"The supported dynamic matrix pricing template of the Price Model.",
            "title":"Supported Dynamic Matrix Pricing Template",
            "readOnly":true
        },
        "editRestriction":{
            "type":"string",
            "format":"",
            "description":"Pricing Edit Restriction.",
            "title":"Edit Restriction",
            "readOnly":true,
            "enum":[
                "UNRESTRICTED",
                "ONLY_REORDERABLE",
                "RESTRICTED"
            ]
        },
        "listType":{
            "type":"string",
            "format":"",
            "description":"List Type.",
            "title":"The List Type for the price model",
            "enum":[
                "priceList",
                "discountList",
                "advanced",
                "markupList"
            ]
        },
        "adjustmentType":{
            "type":"string",
            "format":"",
            "description":"Adjustment Type.",
            "title":"The Adjustment Type of price model",
            "enum":[
                "discountPercent",
                "discountAmount",
                "markupPercent",
                "markupAmount"
            ]
        },
        "priceModelItems":{
            "format":"",
            "description":"List of model items for the Price Model.",
            "title":"Model Items",
            "readOnly":true,
            "allOf":[
                {
                    "$ref":"#/definitions/PricingResourceCollection_PriceModelItem"
                }
            ]
        }
    }
}

Nested Schema : Created By

Title: Created By

Read Only: true

The details of the user who created the record.

Match All

Show Source

• object UserDetails

{
    "format":"",
    "description":"The details of the user who created the record.",
    "title":"Created By",
    "readOnly":true,
    "allOf":[
        {
            "$ref":"#/definitions/UserDetails"
        }
    ]
}

Nested Schema : Model Data

Title: Model Data

Read Only: true

List of data for the Price Model.

Match All

Show Source

• object PricingResourceCollection_PricingModelData

{
    "format":"",
    "description":"List of data for the Price Model.",
    "title":"Model Data",
    "readOnly":true,
    "allOf":[
        {
            "$ref":"#/definitions/PricingResourceCollection_PricingModelData"
        }
    ]
}

Nested Schema : Last Modified By

Title: Last Modified By

Read Only: true

The details of the user who modified the record.

Match All

Show Source

• object UserDetails

{
    "format":"",
    "description":"The details of the user who modified the record.",
    "title":"Last Modified By",
    "readOnly":true,
    "allOf":[
        {
            "$ref":"#/definitions/UserDetails"
        }
    ]
}

Nested Schema : Links

Type: array

Title: Links

Read Only: true

The link relations associated with the resource instance.

Show Source

• Array of: object Link

{
    "type":"array",
    "format":"",
    "description":"The link relations associated with the resource instance.",
    "title":"Links",
    "readOnly":true,
    "items":{
        "$ref":"#/definitions/Link"
    }
}

Nested Schema : Model Items

Title: Model Items

Read Only: true

List of model items for the Price Model.

Match All

Show Source

• object PricingResourceCollection_PriceModelItem

{
    "format":"",
    "description":"List of model items for the Price Model.",
    "title":"Model Items",
    "readOnly":true,
    "allOf":[
        {
            "$ref":"#/definitions/PricingResourceCollection_PriceModelItem"
        }
    ]
}

Nested Schema : Simple Conditions

Title: Simple Conditions

A collection of simple Type conditions applied by the Price Model. This is optional for other condition type.

Match All

Show Source

• object SimpleConditions

{
    "format":"",
    "description":"A collection of simple Type conditions applied by the Price Model. This is optional for other condition type.",
    "title":"Simple Conditions",
    "allOf":[
        {
            "$ref":"#/definitions/SimpleConditions"
        }
    ]
}

Nested Schema : PricingResourceCollection_PricingModelData

Type: object

Show Source

• count: integer()
  Title: Count

  Read Only: true

  The number of resource instances returned in the current range.
• createdBy: Created By
  Title: Created By

  Read Only: true

  The details of the user who created the record.
• hasMore: boolean()
  Title: HasMore

  Read Only: true

  Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
• items: array items
• lastModifiedBy: Last Modified By
  Title: Last Modified By

  Read Only: true

  The details of the user who modified the record.
• limit: integer()
  Title: Limit

  Read Only: true

  The actual paging size used by the server.
• links: array Links
  Title: Links

  Read Only: true

  The link relations associated with the resource instance.
• offset: integer()
  Title: OffSet

  Read Only: true

  The offset value used in the current page.
• totalResults: integer()
  Title: Total Results

  Read Only: true

  Captures the total count of the resource instances, which not only includes the instances in the current range, but all instances on the server that satisfy the request.

{
    "properties":{
        "createdBy":{
            "format":"",
            "description":"The details of the user who created the record.",
            "title":"Created By",
            "readOnly":true,
            "allOf":[
                {
                    "$ref":"#/definitions/UserDetails"
                }
            ]
        },
        "lastModifiedBy":{
            "format":"",
            "description":"The details of the user who modified the record.",
            "title":"Last Modified By",
            "readOnly":true,
            "allOf":[
                {
                    "$ref":"#/definitions/UserDetails"
                }
            ]
        },
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/PricingModelData"
            }
        },
        "offset":{
            "type":"integer",
            "format":"",
            "description":"The offset value used in the current page.",
            "title":"OffSet",
            "readOnly":true
        },
        "limit":{
            "type":"integer",
            "format":"",
            "description":"The actual paging size used by the server.",
            "title":"Limit",
            "readOnly":true
        },
        "count":{
            "type":"integer",
            "format":"",
            "description":"The number of resource instances returned in the current range.",
            "title":"Count",
            "readOnly":true
        },
        "totalResults":{
            "type":"integer",
            "format":"",
            "description":"Captures the total count of the resource instances, which not only includes the instances in the current range, but all instances on the server that satisfy the request.",
            "title":"Total Results",
            "readOnly":true
        },
        "hasMore":{
            "type":"boolean",
            "format":"",
            "description":"Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.",
            "title":"HasMore",
            "readOnly":true
        },
        "links":{
            "type":"array",
            "format":"",
            "description":"The link relations associated with the resource instance.",
            "title":"Links",
            "readOnly":true,
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    }
}

Nested Schema : Created By

Title: Created By

Read Only: true

The details of the user who created the record.

Match All

Show Source

• object UserDetails

{
    "format":"",
    "description":"The details of the user who created the record.",
    "title":"Created By",
    "readOnly":true,
    "allOf":[
        {
            "$ref":"#/definitions/UserDetails"
        }
    ]
}

Nested Schema : items

Type: array

Show Source

• Array of: object PricingModelData

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/PricingModelData"
    }
}

Nested Schema : Last Modified By

Title: Last Modified By

Read Only: true

The details of the user who modified the record.

Match All

Show Source

• object UserDetails

{
    "format":"",
    "description":"The details of the user who modified the record.",
    "title":"Last Modified By",
    "readOnly":true,
    "allOf":[
        {
            "$ref":"#/definitions/UserDetails"
        }
    ]
}

Nested Schema : Links

Type: array

Title: Links

Read Only: true

The link relations associated with the resource instance.

Show Source

• Array of: object Link

{
    "type":"array",
    "format":"",
    "description":"The link relations associated with the resource instance.",
    "title":"Links",
    "readOnly":true,
    "items":{
        "$ref":"#/definitions/Link"
    }
}

Nested Schema : PricingModelData

Type: object

Show Source

• blockPrices: array Block Prices
  Title: Block Prices

  The block price.
• blockSize: number()
  Title: Block Size

  The block size.
• bomItemName: string()
  Title: BOM Item Name

  Read Only: true

  The BOM item's display name. When clients sets field bomItemVariableName, this field should also be explicitly set in the request.
• bomItemVariableName: string()
  Title: BOM Item Variable Name

  Read Only: true

  The BOM Item's variable name.
• chargeDefinition: string()
  Title: Charge Definition

  Read Only: true

  Display Name of the Charge Definition.
• chargeDefinitionCode: string()
  Title: Charge Definition Code

  Read Only: true

  The unique code of the Charge Definition.
• chargeDefinitionId: integer()
  Title: Charge Definition ID

  Read Only: true

  ID of the Charge Definition.
• chargeType: string()
  Title: Charge Type

  Read Only: true

  The category of charge.
• createdBy: Created By
  Title: Created By

  Read Only: true

  The details of the user who created the record.
• dateAdded: string(yyyy-MM-dd'T'HH:mm:ss.SSS'Z')
  Title: Date Added

  Read Only: true

  Creation date of the Price Model Data.
• dateModified: string(yyyy-MM-dd'T'HH:mm:ss.SSS'Z')
  Title: Date Modified

  Read Only: true

  Last modified date of the Price Model Data.
• description: string()
  Title: Description

  Read Only: true

  The description of the Price Model Data
• dynamicPricingType: string()
  Title: Dynamic Pricing Type

  Read Only: true

  Allowed Values: [ "static", "advanced", "volume", "tiered", "rateCard", "attributeBasedCharge" ]

  The dynamic pricing type of the charge.
• endDate: string(yyyy-MM-dd'T'HH:mm:ss.SSS'Z')
  Title: End Date

  Read Only: true

  The date at which the Charge will end.
• id: integer()
  Title: Id

  Read Only: true

  The Unique Identifier of the Price Model Data.
• lastModifiedBy: Last Modified By
  Title: Last Modified By

  Read Only: true

  The details of the user who modified the record.
• links: array Links
  Title: Links

  Read Only: true

  The link relations associated with the resource instance.
• partNumber: string()
  Title: Part Number

  Read Only: true

  The part Number of the Price Model Data.This should match the Part Lookup's lookupCode.
• pricePeriod: string()
  Title: Price Period

  Read Only: true

  The billing period.
• prices: array Prices
  Title: Prices

  The item prices.
• priceType: string()
  Title: Price Type

  Read Only: true

  The type of charge.
• primaryCharge: boolean()
  Title: Primary Charge

  Read Only: true

  Indicates whether this is the primary charge.
• rangeFrom: number()
  Title: Range From

  Read Only: true

  The starting range of the Price Model Data.
• rangeTo: number()
  Title: Range To

  Read Only: true

  The ending range of the Price Model Data.
• rateCardName: string()
  Title: Rate Card Name

  Read Only: true

  Rate Card name (Preview only. Not available for use.)
• rateCardVariableName: string()
  Title: Rate Card Variable Name

  Read Only: true

  Rate Card variable name (Preview only. Not available for use.)
• ratePlanName: string()
  Title: Rate Plan Name

  Read Only: true

  Rate Plan name.
• rootBomItemName: string()
  Title: Root BOM Item Name

  Read Only: true

  The root BOM item's display name.
• rootBomItemVariableName: string()
  Title: Root BOM Item Variable Name

  Read Only: true

  The root BOM item's variable name.
• serviceDuration: integer()
  Title: Service Duration

  Read Only: true

  Service duration.
• serviceDurationPeriod: string()
  Title: Service Duration Period

  Read Only: true

  Service duration period code.
• serviceDurationType: string()
  Title: Service Duration Type

  Read Only: true

  Service duration type.
• startDate: string(yyyy-MM-dd'T'HH:mm:ss.SSS'Z')
  Title: Start Date

  Read Only: true

  The date from which the Charge will be applicable.
• usageUOM: string()
  Title: Usage UOM

  Read Only: true

  The unit of measure for the charge.

{
    "properties":{
        "createdBy":{
            "format":"",
            "description":"The details of the user who created the record.",
            "title":"Created By",
            "readOnly":true,
            "allOf":[
                {
                    "$ref":"#/definitions/UserDetails"
                }
            ]
        },
        "lastModifiedBy":{
            "format":"",
            "description":"The details of the user who modified the record.",
            "title":"Last Modified By",
            "readOnly":true,
            "allOf":[
                {
                    "$ref":"#/definitions/UserDetails"
                }
            ]
        },
        "id":{
            "type":"integer",
            "format":"",
            "description":"The Unique Identifier of the Price Model Data.",
            "title":"Id",
            "readOnly":true
        },
        "partNumber":{
            "type":"string",
            "format":"",
            "description":"The part Number of the Price Model Data.This should match the Part Lookup's lookupCode.",
            "title":"Part Number",
            "readOnly":true
        },
        "description":{
            "type":"string",
            "format":"",
            "description":"The description of the Price Model Data",
            "title":"Description",
            "readOnly":true
        },
        "rangeFrom":{
            "type":"number",
            "format":"",
            "description":"The starting range of the Price Model Data.",
            "title":"Range From",
            "readOnly":true
        },
        "rangeTo":{
            "type":"number",
            "format":"",
            "description":"The ending range of the Price Model Data.",
            "title":"Range To",
            "readOnly":true
        },
        "dateModified":{
            "type":"string",
            "format":"yyyy-MM-dd'T'HH:mm:ss.SSS'Z'",
            "description":"Last modified date of the Price Model Data.",
            "title":"Date Modified",
            "readOnly":true
        },
        "dateAdded":{
            "type":"string",
            "format":"yyyy-MM-dd'T'HH:mm:ss.SSS'Z'",
            "description":"Creation date of the Price Model Data.",
            "title":"Date Added",
            "readOnly":true
        },
        "prices":{
            "type":"array",
            "format":"",
            "description":"The item prices.",
            "title":"Prices",
            "items":{
                "$ref":"#/definitions/PricingCurrencyValues"
            }
        },
        "bomItemName":{
            "type":"string",
            "format":"",
            "description":"The BOM item's display name. When clients sets field bomItemVariableName, this field should also be explicitly set in the request.",
            "title":"BOM Item Name",
            "readOnly":true
        },
        "rootBomItemName":{
            "type":"string",
            "format":"",
            "description":"The root BOM item's display name.",
            "title":"Root BOM Item Name",
            "readOnly":true
        },
        "startDate":{
            "type":"string",
            "format":"yyyy-MM-dd'T'HH:mm:ss.SSS'Z'",
            "description":"The date from which the Charge will be applicable.",
            "title":"Start Date",
            "readOnly":true
        },
        "endDate":{
            "type":"string",
            "format":"yyyy-MM-dd'T'HH:mm:ss.SSS'Z'",
            "description":"The date at which the Charge will end.",
            "title":"End Date",
            "readOnly":true
        },
        "chargeDefinition":{
            "type":"string",
            "format":"",
            "description":"Display Name of the Charge Definition.",
            "title":"Charge Definition",
            "readOnly":true
        },
        "chargeDefinitionCode":{
            "type":"string",
            "format":"",
            "description":"The unique code of the Charge Definition.",
            "title":"Charge Definition Code",
            "readOnly":true
        },
        "chargeDefinitionId":{
            "type":"integer",
            "format":"",
            "description":"ID of the Charge Definition.",
            "title":"Charge Definition ID",
            "readOnly":true
        },
        "links":{
            "type":"array",
            "format":"",
            "description":"The link relations associated with the resource instance.",
            "title":"Links",
            "readOnly":true,
            "items":{
                "$ref":"#/definitions/Link"
            }
        },
        "bomItemVariableName":{
            "type":"string",
            "format":"",
            "description":"The BOM Item's variable name.",
            "title":"BOM Item Variable Name",
            "readOnly":true
        },
        "rootBomItemVariableName":{
            "type":"string",
            "format":"",
            "description":"The root BOM item's variable name.",
            "title":"Root BOM Item Variable Name",
            "readOnly":true
        },
        "chargeType":{
            "type":"string",
            "format":"",
            "description":"The category of charge.",
            "title":"Charge Type",
            "readOnly":true
        },
        "priceType":{
            "type":"string",
            "format":"",
            "description":"The type of charge.",
            "title":"Price Type",
            "readOnly":true
        },
        "pricePeriod":{
            "type":"string",
            "format":"",
            "description":"The billing period.",
            "title":"Price Period",
            "readOnly":true
        },
        "usageUOM":{
            "type":"string",
            "format":"",
            "description":"The unit of measure for the charge.",
            "title":"Usage UOM",
            "readOnly":true
        },
        "primaryCharge":{
            "type":"boolean",
            "format":"",
            "description":"Indicates whether this is the primary charge.",
            "title":"Primary Charge",
            "readOnly":true
        },
        "rateCardVariableName":{
            "type":"string",
            "format":"",
            "description":"Rate Card variable name (Preview only. Not available for use.)",
            "title":"Rate Card Variable Name",
            "readOnly":true
        },
        "rateCardName":{
            "type":"string",
            "format":"",
            "description":"Rate Card name (Preview only. Not available for use.)",
            "title":"Rate Card Name",
            "readOnly":true
        },
        "dynamicPricingType":{
            "type":"string",
            "format":"",
            "description":"The dynamic pricing type of the charge.",
            "title":"Dynamic Pricing Type",
            "readOnly":true,
            "enum":[
                "static",
                "advanced",
                "volume",
                "tiered",
                "rateCard",
                "attributeBasedCharge"
            ]
        },
        "ratePlanName":{
            "type":"string",
            "format":"",
            "description":"Rate Plan name.",
            "title":"Rate Plan Name",
            "readOnly":true
        },
        "serviceDuration":{
            "type":"integer",
            "format":"",
            "description":"Service duration.",
            "title":"Service Duration",
            "readOnly":true
        },
        "serviceDurationPeriod":{
            "type":"string",
            "format":"",
            "description":"Service duration period code.",
            "title":"Service Duration Period",
            "readOnly":true
        },
        "serviceDurationType":{
            "type":"string",
            "format":"",
            "description":"Service duration type.",
            "title":"Service Duration Type",
            "readOnly":true
        },
        "blockSize":{
            "type":"number",
            "format":"",
            "description":"The block size.",
            "title":"Block Size"
        },
        "blockPrices":{
            "type":"array",
            "format":"",
            "description":"The block price.",
            "title":"Block Prices",
            "items":{
                "$ref":"#/definitions/PricingCurrencyValues"
            }
        }
    }
}

Nested Schema : Block Prices

Type: array

Title: Block Prices

The block price.

Show Source

• Array of: object PricingCurrencyValues

{
    "type":"array",
    "format":"",
    "description":"The block price.",
    "title":"Block Prices",
    "items":{
        "$ref":"#/definitions/PricingCurrencyValues"
    }
}

Nested Schema : Created By

Title: Created By

Read Only: true

The details of the user who created the record.

Match All

Show Source

• object UserDetails

{
    "format":"",
    "description":"The details of the user who created the record.",
    "title":"Created By",
    "readOnly":true,
    "allOf":[
        {
            "$ref":"#/definitions/UserDetails"
        }
    ]
}

Nested Schema : Last Modified By

Title: Last Modified By

Read Only: true

The details of the user who modified the record.

Match All

Show Source

• object UserDetails

{
    "format":"",
    "description":"The details of the user who modified the record.",
    "title":"Last Modified By",
    "readOnly":true,
    "allOf":[
        {
            "$ref":"#/definitions/UserDetails"
        }
    ]
}

Nested Schema : Links

Type: array

Title: Links

Read Only: true

The link relations associated with the resource instance.

Show Source

• Array of: object Link

{
    "type":"array",
    "format":"",
    "description":"The link relations associated with the resource instance.",
    "title":"Links",
    "readOnly":true,
    "items":{
        "$ref":"#/definitions/Link"
    }
}

Nested Schema : Prices

Type: array

Title: Prices

The item prices.

Show Source

• Array of: object PricingCurrencyValues

{
    "type":"array",
    "format":"",
    "description":"The item prices.",
    "title":"Prices",
    "items":{
        "$ref":"#/definitions/PricingCurrencyValues"
    }
}

Nested Schema : PricingCurrencyValues

Type: object

Show Source

• currencyCode: string()
  Title: Currency Code

  The currency code.
• value: number()
  Title: Value

  The currency value.

{
    "properties":{
        "currencyCode":{
            "type":"string",
            "format":"",
            "description":"The currency code.",
            "title":"Currency Code"
        },
        "value":{
            "type":"number",
            "format":"",
            "description":"The currency value.",
            "title":"Value"
        }
    }
}

Nested Schema : Link

Type: object

Show Source

• href: string
• name: string
• rel: string

{
    "properties":{
        "rel":{
            "type":"string"
        },
        "href":{
            "type":"string"
        },
        "name":{
            "type":"string"
        }
    }
}

Nested Schema : PricingResourceCollection_PriceModelItem

Type: object

Show Source

• count: integer()
  Title: Count

  Read Only: true

  The number of resource instances returned in the current range.
• createdBy: Created By
  Title: Created By

  Read Only: true

  The details of the user who created the record.
• hasMore: boolean()
  Title: HasMore

  Read Only: true

  Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
• items: array items
• lastModifiedBy: Last Modified By
  Title: Last Modified By

  Read Only: true

  The details of the user who modified the record.
• limit: integer()
  Title: Limit

  Read Only: true

  The actual paging size used by the server.
• links: array Links
  Title: Links

  Read Only: true

  The link relations associated with the resource instance.
• offset: integer()
  Title: OffSet

  Read Only: true

  The offset value used in the current page.
• totalResults: integer()
  Title: Total Results

  Read Only: true

  Captures the total count of the resource instances, which not only includes the instances in the current range, but all instances on the server that satisfy the request.

{
    "properties":{
        "createdBy":{
            "format":"",
            "description":"The details of the user who created the record.",
            "title":"Created By",
            "readOnly":true,
            "allOf":[
                {
                    "$ref":"#/definitions/UserDetails"
                }
            ]
        },
        "lastModifiedBy":{
            "format":"",
            "description":"The details of the user who modified the record.",
            "title":"Last Modified By",
            "readOnly":true,
            "allOf":[
                {
                    "$ref":"#/definitions/UserDetails"
                }
            ]
        },
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/PriceModelItem"
            }
        },
        "offset":{
            "type":"integer",
            "format":"",
            "description":"The offset value used in the current page.",
            "title":"OffSet",
            "readOnly":true
        },
        "limit":{
            "type":"integer",
            "format":"",
            "description":"The actual paging size used by the server.",
            "title":"Limit",
            "readOnly":true
        },
        "count":{
            "type":"integer",
            "format":"",
            "description":"The number of resource instances returned in the current range.",
            "title":"Count",
            "readOnly":true
        },
        "totalResults":{
            "type":"integer",
            "format":"",
            "description":"Captures the total count of the resource instances, which not only includes the instances in the current range, but all instances on the server that satisfy the request.",
            "title":"Total Results",
            "readOnly":true
        },
        "hasMore":{
            "type":"boolean",
            "format":"",
            "description":"Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.",
            "title":"HasMore",
            "readOnly":true
        },
        "links":{
            "type":"array",
            "format":"",
            "description":"The link relations associated with the resource instance.",
            "title":"Links",
            "readOnly":true,
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    }
}

Nested Schema : Created By

Title: Created By

Read Only: true

The details of the user who created the record.

Match All

Show Source

• object UserDetails

{
    "format":"",
    "description":"The details of the user who created the record.",
    "title":"Created By",
    "readOnly":true,
    "allOf":[
        {
            "$ref":"#/definitions/UserDetails"
        }
    ]
}

Nested Schema : items

Type: array

Show Source

• Array of: object PriceModelItem

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/PriceModelItem"
    }
}

Nested Schema : Last Modified By

Title: Last Modified By

Read Only: true

The details of the user who modified the record.

Match All

Show Source

• object UserDetails

{
    "format":"",
    "description":"The details of the user who modified the record.",
    "title":"Last Modified By",
    "readOnly":true,
    "allOf":[
        {
            "$ref":"#/definitions/UserDetails"
        }
    ]
}

Nested Schema : Links

Type: array

Title: Links

Read Only: true

The link relations associated with the resource instance.

Show Source

• Array of: object Link

{
    "type":"array",
    "format":"",
    "description":"The link relations associated with the resource instance.",
    "title":"Links",
    "readOnly":true,
    "items":{
        "$ref":"#/definitions/Link"
    }
}

Nested Schema : PriceModelItem

Type: object

Show Source

• bomItemName: string()
  Title: BOM Item Name

  The BOM item's display name. When clients sets field bomItemVariableName, this field should also be explicitly set in the request.
• bomItemVariableName: string()
  Title: BOM Item Variable Name

  The BOM Item's variable name.
• chargeCount: integer()
  Title: Associated Charges Count

  Read Only: true

  The count of charges directly associated with this price model item.
• charges: Associated Charges
  Title: Associated Charges

  Read Only: true

  The standalone charges associated with this price model item.
• createdBy: Created By
  Title: Created By

  Read Only: true

  The details of the user who created the record.
• dateAdded: string(yyyy-MM-dd'T'HH:mm:ss.SSS'Z')
  Title: Date Added

  Read Only: true

  Creation date of the Price Model Item.
• dateModified: string(yyyy-MM-dd'T'HH:mm:ss.SSS'Z')
  Title: Date Modified

  Read Only: true

  Last modified date of the Price Model Item.
• description: string()
  Title: Part Description

  Read Only: true

  The description of the Price Model Item.
• hasRatePlanSupport: boolean()
  Title: Has Rate Plan Support

  Read Only: true

  Indicates if the Price Model Item supports rate plans.
• id: integer()
  Title: Id

  Read Only: true

  The Unique Identifier of the Price Model Data.
• integrationId: string()
  Title: Integration Id

  Read Only: true

  Price List Item ID from SCM.
• lastModifiedBy: Last Modified By
  Title: Last Modified By

  Read Only: true

  The details of the user who modified the record.
• links: array Links
  Title: Links

  Read Only: true

  The link relations associated with the resource instance.
• partNumber: string()
  Title: Part Number

  The part Number of the Price Model Item.This should match the Part Lookup's lookupCode.
• ratePlanCount: integer()
  Title: Associated Rate Plans Count

  Read Only: true

  The count of rate plans linked to this price model item.
• ratePlans: Associated Rate Plans
  Title: Associated Rate Plans

  Read Only: true

  The rate plans linked to this price model item.
• rootBomItemName: string()
  Title: Root BOM Item Name

  The root BOM item's display name.
• rootBomItemVariableName: string()
  Title: Root BOM Item Variable Name

  The root BOM item's variable name.
• salesProductType: string()
  Title: Sales Product Type

  Read Only: true

  The sales product type of the Price Model Item.
• serviceDuration: integer()
  Title: Service Duration

  The service duration of this price model item. This value is relevant only for parts with variable service duration type and is ignored for other types.
• serviceDurationPeriod: string()
  Title: Service Duration Period

  The service duration period code of this price model item. This value is relevant only for parts with variable service duration type and is ignored for other types.
• serviceDurationType: string()
  Title: Service Duration Type

  Service duration type.

{
    "properties":{
        "createdBy":{
            "format":"",
            "description":"The details of the user who created the record.",
            "title":"Created By",
            "readOnly":true,
            "allOf":[
                {
                    "$ref":"#/definitions/UserDetails"
                }
            ]
        },
        "lastModifiedBy":{
            "format":"",
            "description":"The details of the user who modified the record.",
            "title":"Last Modified By",
            "readOnly":true,
            "allOf":[
                {
                    "$ref":"#/definitions/UserDetails"
                }
            ]
        },
        "id":{
            "type":"integer",
            "format":"",
            "description":"The Unique Identifier of the Price Model Data.",
            "title":"Id",
            "readOnly":true
        },
        "integrationId":{
            "type":"string",
            "format":"",
            "description":"Price List Item ID from SCM.",
            "title":"Integration Id",
            "readOnly":true
        },
        "links":{
            "type":"array",
            "format":"",
            "description":"The link relations associated with the resource instance.",
            "title":"Links",
            "readOnly":true,
            "items":{
                "$ref":"#/definitions/Link"
            }
        },
        "partNumber":{
            "type":"string",
            "format":"",
            "description":"The part Number of the Price Model Item.This should match the Part Lookup's lookupCode.",
            "title":"Part Number"
        },
        "description":{
            "type":"string",
            "format":"",
            "description":"The description of the Price Model Item.",
            "title":"Part Description",
            "readOnly":true
        },
        "salesProductType":{
            "type":"string",
            "format":"",
            "description":"The sales product type of the Price Model Item.",
            "title":"Sales Product Type",
            "readOnly":true
        },
        "bomItemVariableName":{
            "type":"string",
            "format":"",
            "description":"The BOM Item's variable name.",
            "title":"BOM Item Variable Name"
        },
        "bomItemName":{
            "type":"string",
            "format":"",
            "description":"The BOM item's display name. When clients sets field bomItemVariableName, this field should also be explicitly set in the request.",
            "title":"BOM Item Name"
        },
        "rootBomItemVariableName":{
            "type":"string",
            "format":"",
            "description":"The root BOM item's variable name.",
            "title":"Root BOM Item Variable Name"
        },
        "rootBomItemName":{
            "type":"string",
            "format":"",
            "description":"The root BOM item's display name.",
            "title":"Root BOM Item Name"
        },
        "dateModified":{
            "type":"string",
            "format":"yyyy-MM-dd'T'HH:mm:ss.SSS'Z'",
            "description":"Last modified date of the Price Model Item.",
            "title":"Date Modified",
            "readOnly":true
        },
        "dateAdded":{
            "type":"string",
            "format":"yyyy-MM-dd'T'HH:mm:ss.SSS'Z'",
            "description":"Creation date of the Price Model Item.",
            "title":"Date Added",
            "readOnly":true
        },
        "hasRatePlanSupport":{
            "type":"boolean",
            "format":"",
            "description":"Indicates if the Price Model Item supports rate plans.",
            "title":"Has Rate Plan Support",
            "readOnly":true
        },
        "chargeCount":{
            "type":"integer",
            "format":"",
            "description":"The count of charges directly associated with this price model item.",
            "title":"Associated Charges Count",
            "readOnly":true
        },
        "ratePlanCount":{
            "type":"integer",
            "format":"",
            "description":"The count of rate plans linked to this price model item.",
            "title":"Associated Rate Plans Count",
            "readOnly":true
        },
        "serviceDuration":{
            "type":"integer",
            "format":"",
            "description":"The service duration of this price model item. This value is relevant only for parts with variable service duration type and is ignored for other types.",
            "title":"Service Duration"
        },
        "serviceDurationPeriod":{
            "type":"string",
            "format":"",
            "description":"The service duration period code of this price model item. This value is relevant only for parts with variable service duration type and is ignored for other types.",
            "title":"Service Duration Period"
        },
        "serviceDurationType":{
            "type":"string",
            "format":"",
            "description":"Service duration type.",
            "title":"Service Duration Type"
        },
        "ratePlans":{
            "format":"",
            "description":"The rate plans linked to this price model item.",
            "title":"Associated Rate Plans",
            "readOnly":true,
            "allOf":[
                {
                    "$ref":"#/definitions/PricingResourceCollection_PricingRatePlan"
                }
            ]
        },
        "charges":{
            "format":"",
            "description":"The standalone charges associated with this price model item.",
            "title":"Associated Charges",
            "readOnly":true,
            "allOf":[
                {
                    "$ref":"#/definitions/PricingResourceCollection_PricingCharge"
                }
            ]
        }
    }
}

Nested Schema : Associated Charges

Title: Associated Charges

Read Only: true

The standalone charges associated with this price model item.

Match All

Show Source

• object PricingResourceCollection_PricingCharge

{
    "format":"",
    "description":"The standalone charges associated with this price model item.",
    "title":"Associated Charges",
    "readOnly":true,
    "allOf":[
        {
            "$ref":"#/definitions/PricingResourceCollection_PricingCharge"
        }
    ]
}

Nested Schema : Created By

Title: Created By

Read Only: true

The details of the user who created the record.

Match All

Show Source

• object UserDetails

{
    "format":"",
    "description":"The details of the user who created the record.",
    "title":"Created By",
    "readOnly":true,
    "allOf":[
        {
            "$ref":"#/definitions/UserDetails"
        }
    ]
}

Nested Schema : Last Modified By

Title: Last Modified By

Read Only: true

The details of the user who modified the record.

Match All

Show Source

• object UserDetails

{
    "format":"",
    "description":"The details of the user who modified the record.",
    "title":"Last Modified By",
    "readOnly":true,
    "allOf":[
        {
            "$ref":"#/definitions/UserDetails"
        }
    ]
}

Nested Schema : Links

Type: array

Title: Links

Read Only: true

The link relations associated with the resource instance.

Show Source

• Array of: object Link

{
    "type":"array",
    "format":"",
    "description":"The link relations associated with the resource instance.",
    "title":"Links",
    "readOnly":true,
    "items":{
        "$ref":"#/definitions/Link"
    }
}

Nested Schema : Associated Rate Plans

Title: Associated Rate Plans

Read Only: true

The rate plans linked to this price model item.

Match All

Show Source

• object PricingResourceCollection_PricingRatePlan

{
    "format":"",
    "description":"The rate plans linked to this price model item.",
    "title":"Associated Rate Plans",
    "readOnly":true,
    "allOf":[
        {
            "$ref":"#/definitions/PricingResourceCollection_PricingRatePlan"
        }
    ]
}

Nested Schema : PricingResourceCollection_PricingCharge

Type: object

Show Source

• count: integer()
  Title: Count

  Read Only: true

  The number of resource instances returned in the current range.
• createdBy: Created By
  Title: Created By

  Read Only: true

  The details of the user who created the record.
• hasMore: boolean()
  Title: HasMore

  Read Only: true

  Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
• items: array items
• lastModifiedBy: Last Modified By
  Title: Last Modified By

  Read Only: true

  The details of the user who modified the record.
• limit: integer()
  Title: Limit

  Read Only: true

  The actual paging size used by the server.
• links: array Links
  Title: Links

  Read Only: true

  The link relations associated with the resource instance.
• offset: integer()
  Title: OffSet

  Read Only: true

  The offset value used in the current page.
• totalResults: integer()
  Title: Total Results

  Read Only: true

  Captures the total count of the resource instances, which not only includes the instances in the current range, but all instances on the server that satisfy the request.

{
    "properties":{
        "createdBy":{
            "format":"",
            "description":"The details of the user who created the record.",
            "title":"Created By",
            "readOnly":true,
            "allOf":[
                {
                    "$ref":"#/definitions/UserDetails"
                }
            ]
        },
        "lastModifiedBy":{
            "format":"",
            "description":"The details of the user who modified the record.",
            "title":"Last Modified By",
            "readOnly":true,
            "allOf":[
                {
                    "$ref":"#/definitions/UserDetails"
                }
            ]
        },
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/PricingCharge"
            }
        },
        "offset":{
            "type":"integer",
            "format":"",
            "description":"The offset value used in the current page.",
            "title":"OffSet",
            "readOnly":true
        },
        "limit":{
            "type":"integer",
            "format":"",
            "description":"The actual paging size used by the server.",
            "title":"Limit",
            "readOnly":true
        },
        "count":{
            "type":"integer",
            "format":"",
            "description":"The number of resource instances returned in the current range.",
            "title":"Count",
            "readOnly":true
        },
        "totalResults":{
            "type":"integer",
            "format":"",
            "description":"Captures the total count of the resource instances, which not only includes the instances in the current range, but all instances on the server that satisfy the request.",
            "title":"Total Results",
            "readOnly":true
        },
        "hasMore":{
            "type":"boolean",
            "format":"",
            "description":"Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.",
            "title":"HasMore",
            "readOnly":true
        },
        "links":{
            "type":"array",
            "format":"",
            "description":"The link relations associated with the resource instance.",
            "title":"Links",
            "readOnly":true,
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    }
}

Nested Schema : Created By

Title: Created By

Read Only: true

The details of the user who created the record.

Match All

Show Source

• object UserDetails

{
    "format":"",
    "description":"The details of the user who created the record.",
    "title":"Created By",
    "readOnly":true,
    "allOf":[
        {
            "$ref":"#/definitions/UserDetails"
        }
    ]
}

Nested Schema : items

Type: array

Show Source

• Array of: object PricingCharge

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/PricingCharge"
    }
}

Nested Schema : Last Modified By

Title: Last Modified By

Read Only: true

The details of the user who modified the record.

Match All

Show Source

• object UserDetails

{
    "format":"",
    "description":"The details of the user who modified the record.",
    "title":"Last Modified By",
    "readOnly":true,
    "allOf":[
        {
            "$ref":"#/definitions/UserDetails"
        }
    ]
}

Nested Schema : Links

Type: array

Title: Links

Read Only: true

The link relations associated with the resource instance.

Show Source

• Array of: object Link

{
    "type":"array",
    "format":"",
    "description":"The link relations associated with the resource instance.",
    "title":"Links",
    "readOnly":true,
    "items":{
        "$ref":"#/definitions/Link"
    }
}

Nested Schema : PricingCharge

Type: object

Show Source

• blockPrices: array Block Prices
  Title: Block Prices

  The block price.
• blockSize: number()
  Title: Block Size

  The block size.
• chargeDefinition: string()
  Title: Charge Definition

  Read Only: true

  Display Name of the Charge Definition.
• chargeDefinitionCode: string()
  Title: Charge Definition Code

  The unique code of the Charge Definition.
• chargeDefinitionId: integer()
  Title: Charge Definition ID

  Read Only: true

  ID of the Charge Definition.
• chargeType: string()
  Title: Charge Type

  The category of charge.
• createdBy: Created By
  Title: Created By

  Read Only: true

  The details of the user who created the record.
• dateAdded: string(yyyy-MM-dd'T'HH:mm:ss.SSS'Z')
  Title: Date Added

  Read Only: true

  Creation date.
• dateModified: string(yyyy-MM-dd'T'HH:mm:ss.SSS'Z')
  Title: Date Modified

  Read Only: true

  Last modified date.
• dynamicPricingType: string()
  Title: Dynamic Pricing Type

  Allowed Values: [ "static", "advanced", "volume", "tiered", "rateCard", "attributeBasedCharge" ]

  The dynamic pricing type of the charge.
• endDate: string(yyyy-MM-dd'T'HH:mm:ss.SSS'Z')
  Title: End Date

  The date at which the Charge will end.
• id: integer()
  Title: Id

  Read Only: true

  The Unique Identifier of the Charge.
• integrationId: string()
  Title: Integration Id

  Read Only: true

  Rate Plan Charge ID from SCM.
• lastModifiedBy: Last Modified By
  Title: Last Modified By

  Read Only: true

  The details of the user who modified the record.
• links: array Links
  Title: Links

  Read Only: true

  The link relations associated with the resource instance.
• pricePeriod: string()
  Title: Price Period

  The billing period.
• prices: array Prices
  Title: Prices

  The item prices.
• priceType: string()
  Title: Price Type

  The type of charge.
• pricingMatrixVariableName: string()
  Title: Pricing Matrix Variable Name

  Pricing Matrix variable name (Preview only. Not available for use.)
• primaryCharge: boolean()
  Title: Primary Charge

  Indicates whether this is the primary charge.
• rateCardName: string()
  Title: Rate Card Name

  Read Only: true

  Rate Card name (Preview only. Not available for use.)
• rateCardVariableName: string()
  Title: Rate Card Variable Name

  Rate Card variable name (Preview only. Not available for use.)
• startDate: string(yyyy-MM-dd'T'HH:mm:ss.SSS'Z')
  Title: Start Date

  The date from which the Charge will be applicable.
• templateVariableName: string()
  Title: Pricing Matrix Template Variable Name

  The pricing matrix emplate variable name.
• tiers: array Tiers
  Title: Tiers

  The charge tiers.
• usageUOM: string()
  Title: Usage UOM

  The unit of measure for the charge.

{
    "properties":{
        "createdBy":{
            "format":"",
            "description":"The details of the user who created the record.",
            "title":"Created By",
            "readOnly":true,
            "allOf":[
                {
                    "$ref":"#/definitions/UserDetails"
                }
            ]
        },
        "lastModifiedBy":{
            "format":"",
            "description":"The details of the user who modified the record.",
            "title":"Last Modified By",
            "readOnly":true,
            "allOf":[
                {
                    "$ref":"#/definitions/UserDetails"
                }
            ]
        },
        "id":{
            "type":"integer",
            "format":"",
            "description":"The Unique Identifier of the Charge.",
            "title":"Id",
            "readOnly":true
        },
        "dateModified":{
            "type":"string",
            "format":"yyyy-MM-dd'T'HH:mm:ss.SSS'Z'",
            "description":"Last modified date.",
            "title":"Date Modified",
            "readOnly":true
        },
        "dateAdded":{
            "type":"string",
            "format":"yyyy-MM-dd'T'HH:mm:ss.SSS'Z'",
            "description":"Creation date.",
            "title":"Date Added",
            "readOnly":true
        },
        "prices":{
            "type":"array",
            "format":"",
            "description":"The item prices.",
            "title":"Prices",
            "items":{
                "$ref":"#/definitions/PricingCurrencyValues"
            }
        },
        "startDate":{
            "type":"string",
            "format":"yyyy-MM-dd'T'HH:mm:ss.SSS'Z'",
            "description":"The date from which the Charge will be applicable.",
            "title":"Start Date"
        },
        "endDate":{
            "type":"string",
            "format":"yyyy-MM-dd'T'HH:mm:ss.SSS'Z'",
            "description":"The date at which the Charge will end.",
            "title":"End Date"
        },
        "chargeDefinition":{
            "type":"string",
            "format":"",
            "description":"Display Name of the Charge Definition.",
            "title":"Charge Definition",
            "readOnly":true
        },
        "chargeDefinitionCode":{
            "type":"string",
            "format":"",
            "description":"The unique code of the Charge Definition.",
            "title":"Charge Definition Code"
        },
        "chargeDefinitionId":{
            "type":"integer",
            "format":"",
            "description":"ID of the Charge Definition.",
            "title":"Charge Definition ID",
            "readOnly":true
        },
        "integrationId":{
            "type":"string",
            "format":"",
            "description":"Rate Plan Charge ID from SCM.",
            "title":"Integration Id",
            "readOnly":true
        },
        "links":{
            "type":"array",
            "format":"",
            "description":"The link relations associated with the resource instance.",
            "title":"Links",
            "readOnly":true,
            "items":{
                "$ref":"#/definitions/Link"
            }
        },
        "primaryCharge":{
            "type":"boolean",
            "format":"",
            "description":"Indicates whether this is the primary charge.",
            "title":"Primary Charge"
        },
        "chargeType":{
            "type":"string",
            "format":"",
            "description":"The category of charge.",
            "title":"Charge Type"
        },
        "priceType":{
            "type":"string",
            "format":"",
            "description":"The type of charge.",
            "title":"Price Type"
        },
        "pricePeriod":{
            "type":"string",
            "format":"",
            "description":"The billing period.",
            "title":"Price Period"
        },
        "usageUOM":{
            "type":"string",
            "format":"",
            "description":"The unit of measure for the charge.",
            "title":"Usage UOM"
        },
        "rateCardVariableName":{
            "type":"string",
            "format":"",
            "description":"Rate Card variable name (Preview only. Not available for use.)",
            "title":"Rate Card Variable Name"
        },
        "rateCardName":{
            "type":"string",
            "format":"",
            "description":"Rate Card name (Preview only. Not available for use.)",
            "title":"Rate Card Name",
            "readOnly":true
        },
        "dynamicPricingType":{
            "type":"string",
            "format":"",
            "description":"The dynamic pricing type of the charge.",
            "title":"Dynamic Pricing Type",
            "enum":[
                "static",
                "advanced",
                "volume",
                "tiered",
                "rateCard",
                "attributeBasedCharge"
            ]
        },
        "tiers":{
            "type":"array",
            "format":"",
            "description":"The charge tiers.",
            "title":"Tiers",
            "items":{
                "$ref":"#/definitions/ChargeTier"
            }
        },
        "blockSize":{
            "type":"number",
            "format":"",
            "description":"The block size.",
            "title":"Block Size"
        },
        "blockPrices":{
            "type":"array",
            "format":"",
            "description":"The block price.",
            "title":"Block Prices",
            "items":{
                "$ref":"#/definitions/PricingCurrencyValues"
            }
        },
        "pricingMatrixVariableName":{
            "type":"string",
            "format":"",
            "description":"Pricing Matrix variable name (Preview only. Not available for use.)",
            "title":"Pricing Matrix Variable Name"
        },
        "templateVariableName":{
            "type":"string",
            "format":"",
            "description":"The pricing matrix emplate variable name.",
            "title":"Pricing Matrix Template Variable Name"
        }
    }
}

Nested Schema : Block Prices

Type: array

Title: Block Prices

The block price.

Show Source

• Array of: object PricingCurrencyValues

{
    "type":"array",
    "format":"",
    "description":"The block price.",
    "title":"Block Prices",
    "items":{
        "$ref":"#/definitions/PricingCurrencyValues"
    }
}

Nested Schema : Created By

Title: Created By

Read Only: true

The details of the user who created the record.

Match All

Show Source

• object UserDetails

{
    "format":"",
    "description":"The details of the user who created the record.",
    "title":"Created By",
    "readOnly":true,
    "allOf":[
        {
            "$ref":"#/definitions/UserDetails"
        }
    ]
}

Nested Schema : Last Modified By

Title: Last Modified By

Read Only: true

The details of the user who modified the record.

Match All

Show Source

• object UserDetails

{
    "format":"",
    "description":"The details of the user who modified the record.",
    "title":"Last Modified By",
    "readOnly":true,
    "allOf":[
        {
            "$ref":"#/definitions/UserDetails"
        }
    ]
}

Nested Schema : Links

Type: array

Title: Links

Read Only: true

The link relations associated with the resource instance.

Show Source

• Array of: object Link

{
    "type":"array",
    "format":"",
    "description":"The link relations associated with the resource instance.",
    "title":"Links",
    "readOnly":true,
    "items":{
        "$ref":"#/definitions/Link"
    }
}

Nested Schema : Prices

Type: array

Title: Prices

The item prices.

Show Source

• Array of: object PricingCurrencyValues

{
    "type":"array",
    "format":"",
    "description":"The item prices.",
    "title":"Prices",
    "items":{
        "$ref":"#/definitions/PricingCurrencyValues"
    }
}

Nested Schema : Tiers

Type: array

Title: Tiers

The charge tiers.

Show Source

• Array of: object ChargeTier

{
    "type":"array",
    "format":"",
    "description":"The charge tiers.",
    "title":"Tiers",
    "items":{
        "$ref":"#/definitions/ChargeTier"
    }
}

Nested Schema : ChargeTier

Type: object

Show Source

• blockPrices: array Block Prices
  Title: Block Prices

  The block price for the corresponding tier.
• blockSize: number()
  Title: Block Size

  The block size for the corresponding tier.
• prices: array Prices
  Title: Prices

  The prices.
• rangeFrom: number()
  Title: Range From

  The starting range of the Charge.
• rangeTo: number()
  Title: Range To

  Read Only: true

  The ending range of the Charge.

{
    "properties":{
        "rangeFrom":{
            "type":"number",
            "format":"",
            "description":"The starting range of the Charge.",
            "title":"Range From"
        },
        "rangeTo":{
            "type":"number",
            "format":"",
            "description":"The ending range of the Charge.",
            "title":"Range To",
            "readOnly":true
        },
        "prices":{
            "type":"array",
            "format":"",
            "description":"The prices.",
            "title":"Prices",
            "items":{
                "$ref":"#/definitions/PricingCurrencyValues"
            }
        },
        "blockSize":{
            "type":"number",
            "format":"",
            "description":"The block size for the corresponding tier.",
            "title":"Block Size"
        },
        "blockPrices":{
            "type":"array",
            "format":"",
            "description":"The block price for the corresponding tier.",
            "title":"Block Prices",
            "items":{
                "$ref":"#/definitions/PricingCurrencyValues"
            }
        }
    }
}

Nested Schema : Block Prices

Type: array

Title: Block Prices

The block price for the corresponding tier.

Show Source

• Array of: object PricingCurrencyValues

{
    "type":"array",
    "format":"",
    "description":"The block price for the corresponding tier.",
    "title":"Block Prices",
    "items":{
        "$ref":"#/definitions/PricingCurrencyValues"
    }
}

Nested Schema : Prices

Type: array

Title: Prices

The prices.

Show Source

• Array of: object PricingCurrencyValues

{
    "type":"array",
    "format":"",
    "description":"The prices.",
    "title":"Prices",
    "items":{
        "$ref":"#/definitions/PricingCurrencyValues"
    }
}

Nested Schema : PricingResourceCollection_PricingRatePlan

Type: object

Show Source

• count: integer()
  Title: Count

  Read Only: true

  The number of resource instances returned in the current range.
• createdBy: Created By
  Title: Created By

  Read Only: true

  The details of the user who created the record.
• hasMore: boolean()
  Title: HasMore

  Read Only: true

  Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
• items: array items
• lastModifiedBy: Last Modified By
  Title: Last Modified By

  Read Only: true

  The details of the user who modified the record.
• limit: integer()
  Title: Limit

  Read Only: true

  The actual paging size used by the server.
• links: array Links
  Title: Links

  Read Only: true

  The link relations associated with the resource instance.
• offset: integer()
  Title: OffSet

  Read Only: true

  The offset value used in the current page.
• totalResults: integer()
  Title: Total Results

  Read Only: true

  Captures the total count of the resource instances, which not only includes the instances in the current range, but all instances on the server that satisfy the request.

{
    "properties":{
        "createdBy":{
            "format":"",
            "description":"The details of the user who created the record.",
            "title":"Created By",
            "readOnly":true,
            "allOf":[
                {
                    "$ref":"#/definitions/UserDetails"
                }
            ]
        },
        "lastModifiedBy":{
            "format":"",
            "description":"The details of the user who modified the record.",
            "title":"Last Modified By",
            "readOnly":true,
            "allOf":[
                {
                    "$ref":"#/definitions/UserDetails"
                }
            ]
        },
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/PricingRatePlan"
            }
        },
        "offset":{
            "type":"integer",
            "format":"",
            "description":"The offset value used in the current page.",
            "title":"OffSet",
            "readOnly":true
        },
        "limit":{
            "type":"integer",
            "format":"",
            "description":"The actual paging size used by the server.",
            "title":"Limit",
            "readOnly":true
        },
        "count":{
            "type":"integer",
            "format":"",
            "description":"The number of resource instances returned in the current range.",
            "title":"Count",
            "readOnly":true
        },
        "totalResults":{
            "type":"integer",
            "format":"",
            "description":"Captures the total count of the resource instances, which not only includes the instances in the current range, but all instances on the server that satisfy the request.",
            "title":"Total Results",
            "readOnly":true
        },
        "hasMore":{
            "type":"boolean",
            "format":"",
            "description":"Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.",
            "title":"HasMore",
            "readOnly":true
        },
        "links":{
            "type":"array",
            "format":"",
            "description":"The link relations associated with the resource instance.",
            "title":"Links",
            "readOnly":true,
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    }
}

Nested Schema : Created By

Title: Created By

Read Only: true

The details of the user who created the record.

Match All

Show Source

• object UserDetails

{
    "format":"",
    "description":"The details of the user who created the record.",
    "title":"Created By",
    "readOnly":true,
    "allOf":[
        {
            "$ref":"#/definitions/UserDetails"
        }
    ]
}

Nested Schema : items

Type: array

Show Source

• Array of: object PricingRatePlan

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/PricingRatePlan"
    }
}

Nested Schema : Last Modified By

Title: Last Modified By

Read Only: true

The details of the user who modified the record.

Match All

Show Source

• object UserDetails

{
    "format":"",
    "description":"The details of the user who modified the record.",
    "title":"Last Modified By",
    "readOnly":true,
    "allOf":[
        {
            "$ref":"#/definitions/UserDetails"
        }
    ]
}

Nested Schema : Links

Type: array

Title: Links

Read Only: true

The link relations associated with the resource instance.

Show Source

• Array of: object Link

{
    "type":"array",
    "format":"",
    "description":"The link relations associated with the resource instance.",
    "title":"Links",
    "readOnly":true,
    "items":{
        "$ref":"#/definitions/Link"
    }
}

Nested Schema : PricingRatePlan

Type: object

Show Source

• chargeCount: integer()
  Title: Associated Charges Count

  Read Only: true

  The count of charges directly associated with this price model item.
• charges: Charges
  Title: Charges

  Read Only: true

  Rate Plan charges
• createdBy: Created By
  Title: Created By

  Read Only: true

  The details of the user who created the record.
• dateAdded: string(yyyy-MM-dd'T'HH:mm:ss.SSS'Z')
  Title: Date Added

  Read Only: true

  Creation Date of the Pricing Rate Plan.
• dateModified: string(yyyy-MM-dd'T'HH:mm:ss.SSS'Z')
  Title: Date Modified

  Read Only: true

  Last Modified date of the Pricing Rate Plan.
• description: string()
  Title: Description

  Description of the Pricing Rate Plan.
• endDate: string()
  Title: End Date

  The date after which the Pricing Rate Plan will no longer be applicable.
• integrationId: string()
  Title: Integration ID

  The integration ID of the Pricing rate plan.
• lastModifiedBy: Last Modified By
  Title: Last Modified By

  Read Only: true

  The details of the user who modified the record.
• links: array Links
  Title: Links

  Read Only: true

  The link relations associated with the resource instance.
• name: string()
  Title: Name

  Name of the Pricing Rate Plan.
• orderNumber: integer()
  Title: Order Number

  The position in a ordered list of Rate Plan.
• priceModelItemId: integer()
  Title: Price ModelItem Id

  Read Only: true

  The Price ModelItem Id.
• ratePlanNumber: string()
  Title: Rate Plan Number

  Unique Variable Name of the Pricing Rate Plan.
• startDate: string()
  Title: Start Date

  The date from which the Pricing Rate Plan will be applicable.

{
    "properties":{
        "createdBy":{
            "format":"",
            "description":"The details of the user who created the record.",
            "title":"Created By",
            "readOnly":true,
            "allOf":[
                {
                    "$ref":"#/definitions/UserDetails"
                }
            ]
        },
        "lastModifiedBy":{
            "format":"",
            "description":"The details of the user who modified the record.",
            "title":"Last Modified By",
            "readOnly":true,
            "allOf":[
                {
                    "$ref":"#/definitions/UserDetails"
                }
            ]
        },
        "dateAdded":{
            "type":"string",
            "format":"yyyy-MM-dd'T'HH:mm:ss.SSS'Z'",
            "description":"Creation Date of the Pricing Rate Plan.",
            "title":"Date Added",
            "readOnly":true
        },
        "dateModified":{
            "type":"string",
            "format":"yyyy-MM-dd'T'HH:mm:ss.SSS'Z'",
            "description":"Last Modified date of the Pricing Rate Plan.",
            "title":"Date Modified",
            "readOnly":true
        },
        "description":{
            "type":"string",
            "format":"",
            "description":"Description of the Pricing Rate Plan.",
            "title":"Description"
        },
        "endDate":{
            "type":"string",
            "format":"",
            "description":"The date after which the Pricing Rate Plan will no longer be applicable.",
            "title":"End Date"
        },
        "integrationId":{
            "type":"string",
            "format":"",
            "description":"The integration ID of the Pricing rate plan.",
            "title":"Integration ID"
        },
        "name":{
            "type":"string",
            "format":"",
            "description":"Name of the Pricing Rate Plan.",
            "title":"Name"
        },
        "ratePlanNumber":{
            "type":"string",
            "format":"",
            "description":"Unique Variable Name of the Pricing Rate Plan.",
            "title":"Rate Plan Number"
        },
        "startDate":{
            "type":"string",
            "format":"",
            "description":"The date from which the Pricing Rate Plan will be applicable.",
            "title":"Start Date"
        },
        "priceModelItemId":{
            "type":"integer",
            "format":"",
            "description":"The Price ModelItem Id.",
            "title":"Price ModelItem Id",
            "readOnly":true
        },
        "chargeCount":{
            "type":"integer",
            "format":"",
            "description":"The count of charges directly associated  with this price model item.",
            "title":"Associated Charges Count",
            "readOnly":true
        },
        "orderNumber":{
            "type":"integer",
            "format":"",
            "description":"The position in a ordered list of Rate Plan.",
            "title":"Order Number"
        },
        "charges":{
            "format":"",
            "description":"Rate Plan charges",
            "title":"Charges",
            "readOnly":true,
            "allOf":[
                {
                    "$ref":"#/definitions/PricingResourceCollection_PricingCharge"
                }
            ]
        },
        "links":{
            "type":"array",
            "format":"",
            "description":"The link relations associated with the resource instance.",
            "title":"Links",
            "readOnly":true,
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    }
}

Nested Schema : Charges

Title: Charges

Read Only: true

Rate Plan charges

Match All

Show Source

• object PricingResourceCollection_PricingCharge

{
    "format":"",
    "description":"Rate Plan charges",
    "title":"Charges",
    "readOnly":true,
    "allOf":[
        {
            "$ref":"#/definitions/PricingResourceCollection_PricingCharge"
        }
    ]
}

Nested Schema : Created By

Title: Created By

Read Only: true

The details of the user who created the record.

Match All

Show Source

• object UserDetails

{
    "format":"",
    "description":"The details of the user who created the record.",
    "title":"Created By",
    "readOnly":true,
    "allOf":[
        {
            "$ref":"#/definitions/UserDetails"
        }
    ]
}

Nested Schema : Last Modified By

Title: Last Modified By

Read Only: true

The details of the user who modified the record.

Match All

Show Source

• object UserDetails

{
    "format":"",
    "description":"The details of the user who modified the record.",
    "title":"Last Modified By",
    "readOnly":true,
    "allOf":[
        {
            "$ref":"#/definitions/UserDetails"
        }
    ]
}

Nested Schema : Links

Type: array

Title: Links

Read Only: true

The link relations associated with the resource instance.

Show Source

• Array of: object Link

{
    "type":"array",
    "format":"",
    "description":"The link relations associated with the resource instance.",
    "title":"Links",
    "readOnly":true,
    "items":{
        "$ref":"#/definitions/Link"
    }
}

Nested Schema : SimpleConditions

Type: object

Show Source

• ruleExpression: string()
  Title: Rule Expression

  The rule expression that will be evaluated.
• simpleConditionRows: array Simple Condition Rows
  Title: Simple Condition Rows

  A list of Simple Condition Rows.

{
    "properties":{
        "ruleExpression":{
            "type":"string",
            "format":"",
            "description":"The rule expression that will be evaluated.",
            "title":"Rule Expression"
        },
        "simpleConditionRows":{
            "type":"array",
            "format":"",
            "description":"A list of Simple Condition Rows.",
            "title":"Simple Condition Rows",
            "items":{
                "$ref":"#/definitions/SimpleConditionRow"
            }
        }
    }
}

Nested Schema : Simple Condition Rows

Type: array

Title: Simple Condition Rows

A list of Simple Condition Rows.

Show Source

• Array of: object SimpleConditionRow

{
    "type":"array",
    "format":"",
    "description":"A list of Simple Condition Rows.",
    "title":"Simple Condition Rows",
    "items":{
        "$ref":"#/definitions/SimpleConditionRow"
    }
}

Nested Schema : SimpleConditionRow

Type: object

Show Source

• displayName: string()
  Title: Display Name

  The display name of the Simple Condition Row.
• index: integer()
  Title: Index

  The index (starting from 1) of the Simple Condition Row.
• operator: string()
  Title: Operator

  Allowed Values: [ "NONE", "EQUAL_TO", "NOT_EQUAL_TO", "GREATER_THAN", "GREATER_THAN_EQUAL_TO", "LESS_THAN", "LESS_THAN_EQUAL_TO", "CONTAINS", "NOT_CONTAINS", "STARTS_WITH", "NOT_STARTS_WITH", "ENDS_WITH", "NOT_ENDS_WITH" ]

  The operation of the Simple Condition Row.
• value: string()
  Title: Target Value

  The value to match.
• variableName: string()
  Title: Simple Condition Row

  The variable name of the Simple Condition Row.

{
    "properties":{
        "index":{
            "type":"integer",
            "format":"",
            "description":"The index (starting from 1) of the Simple Condition Row.",
            "title":"Index"
        },
        "variableName":{
            "type":"string",
            "format":"",
            "description":"The variable name of the Simple Condition Row.",
            "title":"Simple Condition Row"
        },
        "displayName":{
            "type":"string",
            "format":"",
            "description":"The display name of the Simple Condition Row.",
            "title":"Display Name"
        },
        "operator":{
            "type":"string",
            "format":"",
            "description":"The operation of the Simple Condition Row.",
            "title":"Operator",
            "enum":[
                "NONE",
                "EQUAL_TO",
                "NOT_EQUAL_TO",
                "GREATER_THAN",
                "GREATER_THAN_EQUAL_TO",
                "LESS_THAN",
                "LESS_THAN_EQUAL_TO",
                "CONTAINS",
                "NOT_CONTAINS",
                "STARTS_WITH",
                "NOT_STARTS_WITH",
                "ENDS_WITH",
                "NOT_ENDS_WITH"
            ]
        },
        "value":{
            "type":"string",
            "format":"",
            "description":"The value to match.",
            "title":"Target Value"
        }
    }
}

Back to Top

Examples

The following examples show how to retrieve all price models in Pricing Engine by submitting a GET request to the REST resource using cURL. For more information about cURL, see Use cURL.

The 'limit' query specification is used in the following example to limit the results to three models per page.

curl - X GET - i - H "Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQg" - H "Content-type: application/json"
https://sitename.oracle.com/rest/v16/pricingSetup/models?limit=3

Response Body Sample

{
  "items": [{
      "dateModified": "2021-09-17T11:42:19Z",
      "dateAdded": "2019-05-02T13:37:28Z",
      "name": "Subscription Charges",
      "variableName": "subscriptionCharges",
      "conditionType": "simple",
      "simpleConditions": {
        "ruleExpression": "1 OR 2 OR 3 OR 4 OR 5 OR 6 OR 7 OR 8",
        "simpleConditionRows": [{
            "index": 1,
            "variableName": "oRCL_pRC_partNumber",
            "displayName": "Part Number",
            "operator": "EQUAL_TO",
            "value": "Cloud Backup Service"
          }, {
            "index": 2,
            "variableName": "oRCL_pRC_partNumber",
            "displayName": "Part Number",
            "operator": "EQUAL_TO",
            "value": "Premium Cloud Backup Service"
          }, {
            "index": 3,
            "variableName": "oRCL_pRC_partNumber",
            "displayName": "Part Number",
            "operator": "EQUAL_TO",
            "value": "part10"
          }, {
            "index": 4,
            "variableName": "oRCL_pRC_partNumber",
            "displayName": "Part Number",
            "operator": "EQUAL_TO",
            "value": "part111"
          }, {
            "index": 5,
            "variableName": "oRCL_pRC_partNumber",
            "displayName": "Part Number",
            "operator": "EQUAL_TO",
            "value": "part1120"
          }, {
            "index": 6,
            "variableName": "oRCL_pRC_partNumber",
            "displayName": "Part Number",
            "operator": "EQUAL_TO",
            "value": "Surface Book 2"
          }, {
            "index": 7,
            "variableName": "oRCL_pRC_partNumber",
            "displayName": "Part Number",
            "operator": "EQUAL_TO",
            "value": "QP_Item3"
          }, {
            "index": 8,
            "variableName": "oRCL_pRC_productType",
            "displayName": "Product Type",
            "operator": "EQUAL_TO",
            "value": "subscription"
          }
        ]
      },
      "shared": false,
      "ruleCount": 1,
      "links": [{
          "rel": "self",
          "href": "https://sitename.oracle.com/rest/v16/pricingSetup/models/subscriptionCharges"
        }, {
          "rel": "parent",
          "href": "https://sitename.oracle.com/rest/v16/pricingSetup/models"
        }, {
          "rel": "child",
          "href": "https://sitename.oracle.com/rest/v16/pricingSetup/models/subscriptionCharges/data"
        }
      ],
      "valueType": "absolutePrice",
      "dynamicPricingType": "advanced"
    }, {
      "dateModified": "2021-06-03T07:01:41Z",
      "dateAdded": "2019-07-22T11:41:51Z",
      "name": "CSP",
      "variableName": "cSP",
      "conditionType": "alwaysTrue",
      "shared": true,
      "ruleCount": 2,
      "links": [{
          "rel": "self",
          "href": "https://sitename.oracle.com/rest/v16/pricingSetup/models/cSP"
        }, {
          "rel": "parent",
          "href": "https://sitename.oracle.com/rest/v16/pricingSetup/models"
        }, {
          "rel": "child",
          "href": "https://sitename.oracle.com/rest/v16/pricingSetup/models/cSP/data"
        }
      ],
      "valueType": "discountPercent",
      "dynamicPricingType": "static"
    }, {
      "dateModified": "2019-11-04T17:01:48Z",
      "dateAdded": "2019-11-04T15:02:18Z",
      "name": "CSP ABC Corp",
      "variableName": "cSPABCCorp",
      "conditionType": "simple",
      "simpleConditions": {
        "ruleExpression": "1 OR 2",
        "simpleConditionRows": [{
            "index": 1,
            "variableName": "companyName",
            "displayName": "Company Name",
            "operator": "EQUAL_TO",
            "value": "ABC Corp"
          }, {
            "index": 2,
            "variableName": "repeatCustomer",
            "displayName": "RepeatCustomer",
            "operator": "EQUAL_TO",
            "value": "true"
          }
        ]
      },
      "shared": false,
      "ruleCount": 1,
      "links": [{
          "rel": "self",
          "href": "https://sitename.oracle.com/rest/v16/pricingSetup/models/cSPABCCorp"
        }, {
          "rel": "parent",
          "href": "https://sitename.oracle.com/rest/v16/pricingSetup/models"
        }, {
          "rel": "child",
          "href": "https://sitename.oracle.com/rest/v16/pricingSetup/models/cSPABCCorp/data"
        }
      ],
      "valueType": "absolutePrice",
      "dynamicPricingType": "advanced"
    }
  ],
  "offset": 0,
  "limit": 3,
  "count": 3,
  "hasMore": true,
  "links": [{
      "rel": "canonical",
      "href": "https://sitename.oracle.com/rest/v16/pricingSetup/models"
    }, {
      "rel": "self",
      "href": "https://sitename.oracle.com/rest/v16/pricingSetup/models?offset=0&limit=3"
    }, {
      "rel": "next",
      "href": "https://sitename.oracle.com/rest/v16/pricingSetup/models?offset=3&limit=3"
    }
  ]
}

Back to Top