Jump to

• Request
• Response

Get all subscription usage entitlements

get

/crmRestApi/resources/11.13.18.05/subscriptionUsageEntitlements

Request

Query Parameters

• expand: string
  When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
• fields: string
  This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
  
  Format: ?fields=Attribute1,Attribute2
  
  Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
• finder: string
  Used as a predefined finder to search the collection.
  
  Format ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
  
  The following are the available finder names and corresponding finder variables
  
  

  • PrimaryKey Finds the subscription usage entitlements with the specified primary key.
    Finder Variables
    • UsageEntitlementId; integer; The unique usage entitlements identifier of the subscription usage entitlements used to find it.
  • UsageEntitlementAltKey Finds the subscription usage entitlements with the specified alternate key.
    Finder Variables
    • UsageEntitlementNumber; string; The unique usage entitlement number of the subscription usage entitlements for usage entitlements alternate key.
• 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.
• links: string
  This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
  
  Example:
  self,canonical
  
• 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 fields. 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
• q: string
  This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
  
  Format: ?q=expression1;expression2
  
  You can use these queryable attributes to filter this collection resource using the q query parameter:
  

  • BalanceProfileId; integer; The unique identifier of the balance profile of the subscription usage entitlement.
  • BalanceProfileName; string; The name of the balance profile of the subscription usage entitlement.
  • BalanceProfileNumber; string; The alternate key of the balance profile of the subscription usage entitlement.
  • BusinessUnitId; integer; The unique identifier of the business unit of the subscription usage entitlement.
  • BusinessUnitName; string; The name of the business unit of the subscription usage entitlement.
  • CreatedBy; string; The user who created the subscription usage entitlements.
  • CreationDate; string; The date of creation of the subscription usage entitlements.
  • EndDateActive; string; The end date of the subscription usage entitlement.
  • EntitlementPlanName; string; The name of the entitlement plan of the usage entitlement.
  • EntitlementPlanNumber; string; The alternate key of the entitlement plan of the subscription usage entitlement.
  • InventoryItemId; integer; The unique identifier of subscription product item of the subscription product item of the subscription usage entitlement.
  • ItemNumber; string; The alternate key of the subscription product item of the subscription usage entitlement.
  • LastUpdateDate; string; The date when the subscription usage entitlements was last updated.
  • LastUpdateLogin; string; The login of the user who last updated the subscription usage entitlement.
  • LastUpdatedBy; string; The user who has last updated the subscription usage entitlement.
  • ObjectVersionNumber; integer; The version number of subscription usage entitlement.
  • OrganizationId; integer; The unique identifier of organization of subscription product item of the subscription product item of the subscription usage entitlement.
  • Precedence; integer; The precedence of subscription usage entitlements.
  • PriceListId; integer; The unique identifier of price list of the subscription product item of the subscription usage entitlements.
  • PriceListItemId; integer; The unique identifier of price list item of the subscription product item of the subscription usage entitlements.
  • PriceListName; string; The name of price list of the subscription product item of the subscription usage entitlements.
  • PriceUnitOfMeasure; string; The price unit of measure of the subscription product item of the subscription usage entitlements.
  • PriceUnitOfMeasureCode; string; The price unit of measure code of the subscription product item of the subscription usage entitlements.
  • RatePlanId; integer; The unique identifier of rate plan of the subscription product item of the subscription usage entitlements.
  • RatePlanName; string; The name of rate plan of the subscription product item of the subscription usage entitlements.
  • RatePlanNumber; string; The alternate key of rate plan of the subscription product item of the subscription usage entitlements.
  • RatingModel; string; The rating model of the usage entitlements.
  • RatingModelMeaning; string; The rating model meaning of the usage entitlements.
  • StartDateActive; string; The start date of the subscription usage entitlement.
  • Status; string; The status of the subscription usage entitlement.
  • SummarizedRatingFlag; boolean; The summarized flag of the subscription usage entitlement.
  • UsageEntitlementId; integer; The unique identifier of usage entitlement plan of the subscription usage entitlements.
  • UsageEntitlementNumber; string; The alternate key of usage entitlement plan of the subscription usage entitlements.
• totalResults: boolean
  The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".

Header Parameters

• Metadata-Context: string
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version: string
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Body ()

Root Schema : subscriptionUsageEntitlements

Type: object

Show Source

• count(required): integer
  The number of resource instances returned in the current range.
• hasMore(required): boolean
  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
  Title: Items

  The items in the collection.
• limit(required): integer
  The actual paging size used by the server.
• links(required): array Links
  Title: Links

  The link relations associated with the resource instance.
• offset(required): integer
  The offset value used in the current page.
• totalResults: integer
  The estimated row count when "?totalResults=true", otherwise the count is not included.

{
    "required":[
        "count",
        "hasMore",
        "limit",
        "links",
        "offset"
    ],
    "type":"object",
    "properties":{
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "hasMore":{
            "type":"boolean",
            "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."
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/subscriptionUsageEntitlements-item-response"
            }
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server."
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        }
    },
    "x-hints":{
        "usage":"BusinessObject",
        "group":"OEC"
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object subscriptionUsageEntitlements-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/subscriptionUsageEntitlements-item-response"
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : subscriptionUsageEntitlements-item-response

Type: object

Show Source

• Action: string
  Activate or deactivate action of the subscription usage entitlement.
• BalanceProfileId: integer (int64)
  Title: Balance Profile ID

  The unique identifier of the balance profile of the subscription usage entitlement.
• BalanceProfileName: string
  Title: Profile Name

  Maximum Length: 120

  The name of the balance profile of the subscription usage entitlement.
• BalanceProfileNumber: string
  Title: Profile Number

  Maximum Length: 120

  The alternate key of the balance profile of the subscription usage entitlement.
• BusinessUnitId: integer (int64)
  Title: BU ID

  The unique identifier of the business unit of the subscription usage entitlement.
• BusinessUnitName: string
  Title: Business Unit

  Read Only: true

  Maximum Length: 240

  The name of the business unit of the subscription usage entitlement.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who created the subscription usage entitlements.
• CreationDate: string (date-time)
  Read Only: true

  The date of creation of the subscription usage entitlements.
• EndDateActive: string (date)
  Title: End Date

  Read Only: true

  The end date of the subscription usage entitlement.
• EntitlementPlanName: string
  Title: Name

  Read Only: true

  Maximum Length: 120

  The name of the entitlement plan of the usage entitlement.
• EntitlementPlanNumber: string
  Title: Number

  Read Only: true

  Maximum Length: 120

  The alternate key of the entitlement plan of the subscription usage entitlement.
• entitlementPlans: array Subscription Usage Entitlement Plans
  Title: Subscription Usage Entitlement Plans

  The subscription usage entitlement plan is a configuration for a set of entitlements.
• InventoryItemId: integer (int64)
  Title: Item ID

  The unique identifier of subscription product item of the subscription product item of the subscription usage entitlement.
• ItemNumber: string
  Title: Product Name

  Read Only: true

  Maximum Length: 300

  The alternate key of the subscription product item of the subscription usage entitlement.
• LastUpdateDate: string (date-time)
  Read Only: true

  The date when the subscription usage entitlements was last updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who has last updated the subscription usage entitlement.
• LastUpdateLogin: string
  Read Only: true

  Maximum Length: 32

  The login of the user who last updated the subscription usage entitlement.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ObjectVersionNumber: integer (int32)
  The version number of subscription usage entitlement.
• OrganizationId: integer (int64)
  Title: Inventory Organization

  The unique identifier of organization of subscription product item of the subscription product item of the subscription usage entitlement.
• Precedence: integer
  Title: Precedence

  The precedence of subscription usage entitlements.
• PriceListId: integer (int64)
  Title: Price List

  The unique identifier of price list of the subscription product item of the subscription usage entitlements.
• PriceListItemId: integer (int64)
  Read Only: true

  The unique identifier of price list item of the subscription product item of the subscription usage entitlements.
• PriceListName: string
  Title: Price List Name

  Read Only: true

  Maximum Length: 80

  The name of price list of the subscription product item of the subscription usage entitlements.
• PriceUnitOfMeasure: string
  Title: UOM Name

  Read Only: true

  Maximum Length: 25

  The price unit of measure of the subscription product item of the subscription usage entitlements.
• PriceUnitOfMeasureCode: string
  Title: Pricing UOM

  Maximum Length: 3

  The price unit of measure code of the subscription product item of the subscription usage entitlements.
• RatePlanId: integer (int64)
  Title: Rate Plan ID

  The unique identifier of rate plan of the subscription product item of the subscription usage entitlements.
• RatePlanName: string
  Title: Rate Plan

  Maximum Length: 80

  The name of rate plan of the subscription product item of the subscription usage entitlements.
• RatePlanNumber: string
  Title: Rate Plan Number

  Maximum Length: 120

  The alternate key of rate plan of the subscription product item of the subscription usage entitlements.
• RatingModel: string
  Title: Rating Model

  Read Only: true

  Maximum Length: 30

  The rating model of the usage entitlements.
• RatingModelMeaning: string
  Title: Rating Model

  Read Only: true

  Maximum Length: 80

  The rating model meaning of the usage entitlements.
• StartDateActive: string (date)
  Title: Start Date

  Read Only: true

  The start date of the subscription usage entitlement.
• Status: string
  Title: Status

  Read Only: true

  Maximum Length: 30

  Default Value: ORA_OSS_DRAFT

  The status of the subscription usage entitlement.
• SummarizedRatingFlag: boolean
  Title: Enable summarize rating

  Read Only: true

  Maximum Length: 1

  Default Value: false

  The summarized flag of the subscription usage entitlement.
• UsageEntitlementId: integer (int64)
  Title: Usage Entitlement ID

  The unique identifier of usage entitlement plan of the subscription usage entitlements.
• UsageEntitlementNumber: string
  Title: Usage Entitlement Number

  Maximum Length: 120

  The alternate key of usage entitlement plan of the subscription usage entitlements.

{
    "type":"object",
    "properties":{
        "Action":{
            "type":"string",
            "description":"Activate or deactivate action of the subscription usage entitlement.",
            "nullable":true,
            "x-queryable":false
        },
        "BalanceProfileId":{
            "title":"Balance Profile ID",
            "type":"integer",
            "description":"The unique identifier of the balance profile of the subscription usage entitlement.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "BalanceProfileName":{
            "title":"Profile Name",
            "maxLength":120,
            "type":"string",
            "description":"The name of the balance profile of the subscription usage entitlement.",
            "nullable":false,
            "x-queryable":true
        },
        "BalanceProfileNumber":{
            "title":"Profile Number",
            "maxLength":120,
            "type":"string",
            "description":"The alternate key of the balance profile of the subscription usage entitlement.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "BusinessUnitId":{
            "title":"BU ID",
            "type":"integer",
            "description":"The unique identifier of the business unit of the subscription usage entitlement.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "BusinessUnitName":{
            "title":"Business Unit",
            "maxLength":240,
            "type":"string",
            "description":"The name of the business unit of the subscription usage entitlement.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the subscription usage entitlements.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date of creation of the subscription usage entitlements.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "EndDateActive":{
            "title":"End Date",
            "type":"string",
            "description":"The end date of the subscription usage entitlement.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EntitlementPlanName":{
            "title":"Name",
            "maxLength":120,
            "type":"string",
            "description":"The name of the entitlement plan of the usage entitlement.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "EntitlementPlanNumber":{
            "title":"Number",
            "maxLength":120,
            "type":"string",
            "description":"The alternate key of the entitlement plan of the subscription usage entitlement.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "InventoryItemId":{
            "title":"Item ID",
            "type":"integer",
            "description":"The unique identifier of subscription product item of the subscription product item of the subscription usage entitlement.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ItemNumber":{
            "title":"Product Name",
            "maxLength":300,
            "type":"string",
            "description":"The alternate key of the subscription product item of the subscription usage entitlement.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date when the subscription usage entitlements was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"The login of the user who last updated the subscription usage entitlement.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who has last updated the subscription usage entitlement.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"The version number of subscription usage entitlement.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "OrganizationId":{
            "title":"Inventory Organization",
            "type":"integer",
            "description":"The unique identifier of organization of subscription product item of the subscription product item of the subscription usage entitlement.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "Precedence":{
            "title":"Precedence",
            "type":"integer",
            "description":"The precedence of subscription usage entitlements.",
            "nullable":true,
            "x-queryable":true
        },
        "PriceListId":{
            "title":"Price List",
            "type":"integer",
            "description":"The unique identifier of price list of the subscription product item of the subscription usage entitlements.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18,
                "dependencies":[
                    "InventoryItemId"
                ]
            },
            "x-queryable":true
        },
        "PriceListItemId":{
            "type":"integer",
            "description":"The unique identifier of price list item of the subscription product item of the subscription usage entitlements.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PriceListName":{
            "title":"Price List Name",
            "maxLength":80,
            "type":"string",
            "description":"The name of price list of the subscription product item of the subscription usage entitlements.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PriceUnitOfMeasure":{
            "title":"UOM Name",
            "maxLength":25,
            "type":"string",
            "description":"The price unit of measure of the subscription product item of the subscription usage entitlements.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "controlType":"edit"
            },
            "x-queryable":true
        },
        "PriceUnitOfMeasureCode":{
            "title":"Pricing UOM",
            "maxLength":3,
            "type":"string",
            "description":"The price unit of measure code of the subscription product item of the subscription usage entitlements.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "InventoryItemId"
                ]
            },
            "x-queryable":true
        },
        "RatePlanId":{
            "title":"Rate Plan ID",
            "type":"integer",
            "description":"The unique identifier of rate plan of the subscription product item of the subscription usage entitlements.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18,
                "dependencies":[
                    "InventoryItemId"
                ]
            },
            "x-queryable":true
        },
        "RatePlanName":{
            "title":"Rate Plan",
            "maxLength":80,
            "type":"string",
            "description":"The name of rate plan of the subscription product item of the subscription usage entitlements.",
            "nullable":false,
            "x-queryable":true
        },
        "RatePlanNumber":{
            "title":"Rate Plan Number",
            "maxLength":120,
            "type":"string",
            "description":"The alternate key of rate plan of the subscription product item of the subscription usage entitlements.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "RatingModel":{
            "title":"Rating Model",
            "maxLength":30,
            "type":"string",
            "description":"The rating model of the usage entitlements.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "RatingModelMeaning":{
            "title":"Rating Model",
            "maxLength":80,
            "type":"string",
            "description":"The rating model meaning of the usage entitlements.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "StartDateActive":{
            "title":"Start Date",
            "type":"string",
            "description":"The start date of the subscription usage entitlement.",
            "format":"date",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Status":{
            "title":"Status",
            "maxLength":30,
            "type":"string",
            "description":"The status of the subscription usage entitlement.",
            "nullable":true,
            "readOnly":true,
            "default":"ORA_OSS_DRAFT",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "SummarizedRatingFlag":{
            "title":"Enable summarize rating",
            "maxLength":1,
            "type":"boolean",
            "description":"The summarized flag of the subscription usage entitlement.",
            "nullable":true,
            "readOnly":true,
            "default":false,
            "x-queryable":true
        },
        "UsageEntitlementId":{
            "title":"Usage Entitlement ID",
            "type":"integer",
            "description":"The unique identifier of usage entitlement plan of the subscription usage entitlements.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "UsageEntitlementNumber":{
            "title":"Usage Entitlement Number",
            "maxLength":120,
            "type":"string",
            "description":"The alternate key of usage entitlement plan of the subscription usage entitlements.",
            "nullable":false,
            "x-queryable":true
        },
        "entitlementPlans":{
            "title":"Subscription Usage Entitlement Plans",
            "type":"array",
            "description":"The subscription usage entitlement plan is a configuration for a set of entitlements.",
            "items":{
                "$ref":"#/components/schemas/subscriptionUsageEntitlements-entitlementPlans-item-response"
            },
            "x-cardinality":"1"
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Subscription Usage Entitlement Plans

Type: array

Title: Subscription Usage Entitlement Plans

The subscription usage entitlement plan is a configuration for a set of entitlements.

Show Source

• Array of: object subscriptionUsageEntitlements-entitlementPlans-item-response

{
    "title":"Subscription Usage Entitlement Plans",
    "type":"array",
    "description":"The subscription usage entitlement plan is a configuration for a set of entitlements.",
    "items":{
        "$ref":"#/components/schemas/subscriptionUsageEntitlements-entitlementPlans-item-response"
    },
    "x-cardinality":"1"
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : subscriptionUsageEntitlements-entitlementPlans-item-response

Type: object

Show Source

• allowances: array Subscription Entitlement Plan Details
  Title: Subscription Entitlement Plan Details

  The subscription entitlement plan details resource is used to view, create, update, and delete an entitlement plan detail.
• BalanceProfileId: integer (int64)
  Title: Balance Profile ID

  The unique identifier of balance profile of the subscription usage entitlements.
• commitments: array Subscription Entitlement Plan Commitments
  Title: Subscription Entitlement Plan Commitments

  The commitments resource is used to create a entitlement plan based on commitments. These records can be created only for those balance codes which have the commitment flag enabled.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who created the subscription usage entitlement plans.
• CreationDate: string (date-time)
  Read Only: true

  The date of creation of the subscription usage entitlement plans.
• estimates: array Subscription Entitlement Plan Estimates
  Title: Subscription Entitlement Plan Estimates

  The estimates resource is used to create a entitlement plan based on estimates. These records can be created only for those balance codes which have the estimates flag enabled.
• LastUpdateDate: string (date-time)
  Read Only: true

  The date when the subscription usage entitlement plans was last updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who has last updated the subscription usage entitlement plans.
• LastUpdateLogin: string
  Read Only: true

  Maximum Length: 32

  The login of the user who last updated the subscription usage entitlement plans.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ObjectVersionNumber: integer (int32)
  The version number of subscription usage entitlement plans.
• RatePlanId: integer (int64)
  Title: Rate Plan ID

  The unique identifier of rate plan of the subscription product item of the subscription usage entitlement plans.
• RatingModel: string
  Title: Rating Model

  Maximum Length: 30

  The rating model of the usage entitlement plans.
• SummarizedRatingFlag: boolean
  Title: Enable summarize rating

  Maximum Length: 1

  Default Value: false

  The summarized flag of the subscription usage entitlement plans.
• unitOfMeasureConversions: array Subscription Entitlement Plan UOM Conversions
  Title: Subscription Entitlement Plan UOM Conversions

  The subscription entitlement plan UOM Conversions is used to store the conversion rates between various UOMs for all entitlement plans.
• UsageEntitlementPlanDescription: string
  Title: Description

  Maximum Length: 300

  The description of the subscription usage entitlement plans.
• UsageEntitlementPlanId: integer (int64)
  The unique identifier of the subscription usage entitlement plans.
• UsageEntitlementPlanName: string
  Title: Name

  Maximum Length: 120

  The name of the subscription usage entitlement plans.
• UsageEntitlementPlanNumber: string
  Title: Number

  Maximum Length: 120

  The alternate key of the subscription usage entitlement plans.
• volumePricingRules: array Subscription Entitlement Pricing Rules
  Title: Subscription Entitlement Pricing Rules

  The subscription entitlement plan charge rules resource is used to view, create, update, and delete an entitlement plan.

{
    "type":"object",
    "properties":{
        "BalanceProfileId":{
            "title":"Balance Profile ID",
            "type":"integer",
            "description":"The unique identifier of balance profile of the subscription usage entitlements.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the subscription usage entitlement plans.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date of creation of the subscription usage entitlement plans.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date when the subscription usage entitlement plans was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"The login of the user who last updated the subscription usage entitlement plans.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who has last updated the subscription usage entitlement plans.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"The version number of subscription usage entitlement plans.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "RatePlanId":{
            "title":"Rate Plan ID",
            "type":"integer",
            "description":"The unique identifier of rate plan of the subscription product item of the subscription usage entitlement plans.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "RatingModel":{
            "title":"Rating Model",
            "maxLength":30,
            "type":"string",
            "description":"The rating model of the usage entitlement plans.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "SummarizedRatingFlag":{
            "title":"Enable summarize rating",
            "maxLength":1,
            "type":"boolean",
            "description":"The summarized flag of the subscription usage entitlement plans.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "UsageEntitlementPlanDescription":{
            "title":"Description",
            "maxLength":300,
            "type":"string",
            "description":"The description of the subscription usage entitlement plans.",
            "nullable":true,
            "x-queryable":true
        },
        "UsageEntitlementPlanId":{
            "type":"integer",
            "description":"The unique identifier of the subscription usage entitlement plans.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "UsageEntitlementPlanName":{
            "title":"Name",
            "maxLength":120,
            "type":"string",
            "description":"The name of the subscription usage entitlement plans.",
            "nullable":false,
            "x-queryable":true
        },
        "UsageEntitlementPlanNumber":{
            "title":"Number",
            "maxLength":120,
            "type":"string",
            "description":"The alternate key of the subscription usage entitlement plans.",
            "nullable":false,
            "x-queryable":true
        },
        "allowances":{
            "title":"Subscription Entitlement Plan Details",
            "type":"array",
            "description":"The subscription entitlement plan details resource is used to view, create, update, and delete an entitlement plan detail.",
            "items":{
                "$ref":"#/components/schemas/subscriptionUsageEntitlements-entitlementPlans-allowances-item-response"
            }
        },
        "commitments":{
            "title":"Subscription Entitlement Plan Commitments",
            "type":"array",
            "description":"The commitments resource is used to create a entitlement plan based on commitments. These records can be created only for those balance codes which have the commitment flag enabled.",
            "items":{
                "$ref":"#/components/schemas/subscriptionUsageEntitlements-entitlementPlans-commitments-item-response"
            }
        },
        "estimates":{
            "title":"Subscription Entitlement Plan Estimates",
            "type":"array",
            "description":"The estimates resource is used to create a entitlement plan based on estimates. These records can be created only for those balance codes which have the estimates flag enabled.",
            "items":{
                "$ref":"#/components/schemas/subscriptionUsageEntitlements-entitlementPlans-estimates-item-response"
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "unitOfMeasureConversions":{
            "title":"Subscription Entitlement Plan UOM Conversions",
            "type":"array",
            "description":"The subscription entitlement plan UOM Conversions is used to store the conversion rates between various UOMs for all entitlement plans.",
            "items":{
                "$ref":"#/components/schemas/subscriptionUsageEntitlements-entitlementPlans-unitOfMeasureConversions-item-response"
            }
        },
        "volumePricingRules":{
            "title":"Subscription Entitlement Pricing Rules",
            "type":"array",
            "description":"The subscription entitlement plan charge rules resource is used to view, create, update, and delete an entitlement plan.",
            "items":{
                "$ref":"#/components/schemas/subscriptionUsageEntitlements-entitlementPlans-volumePricingRules-item-response"
            }
        }
    }
}

Nested Schema : Subscription Entitlement Plan Details

Type: array

Title: Subscription Entitlement Plan Details

The subscription entitlement plan details resource is used to view, create, update, and delete an entitlement plan detail.

Show Source

• Array of: object subscriptionUsageEntitlements-entitlementPlans-allowances-item-response

{
    "title":"Subscription Entitlement Plan Details",
    "type":"array",
    "description":"The subscription entitlement plan details resource is used to view, create, update, and delete an entitlement plan detail.",
    "items":{
        "$ref":"#/components/schemas/subscriptionUsageEntitlements-entitlementPlans-allowances-item-response"
    }
}

Nested Schema : Subscription Entitlement Plan Commitments

Type: array

Title: Subscription Entitlement Plan Commitments

The commitments resource is used to create a entitlement plan based on commitments. These records can be created only for those balance codes which have the commitment flag enabled.

Show Source

• Array of: object subscriptionUsageEntitlements-entitlementPlans-commitments-item-response

{
    "title":"Subscription Entitlement Plan Commitments",
    "type":"array",
    "description":"The commitments resource is used to create a entitlement plan based on commitments. These records can be created only for those balance codes which have the commitment flag enabled.",
    "items":{
        "$ref":"#/components/schemas/subscriptionUsageEntitlements-entitlementPlans-commitments-item-response"
    }
}

Nested Schema : Subscription Entitlement Plan Estimates

Type: array

Title: Subscription Entitlement Plan Estimates

The estimates resource is used to create a entitlement plan based on estimates. These records can be created only for those balance codes which have the estimates flag enabled.

Show Source

• Array of: object subscriptionUsageEntitlements-entitlementPlans-estimates-item-response

{
    "title":"Subscription Entitlement Plan Estimates",
    "type":"array",
    "description":"The estimates resource is used to create a entitlement plan based on estimates. These records can be created only for those balance codes which have the estimates flag enabled.",
    "items":{
        "$ref":"#/components/schemas/subscriptionUsageEntitlements-entitlementPlans-estimates-item-response"
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : Subscription Entitlement Plan UOM Conversions

Type: array

Title: Subscription Entitlement Plan UOM Conversions

The subscription entitlement plan UOM Conversions is used to store the conversion rates between various UOMs for all entitlement plans.

Show Source

• Array of: object subscriptionUsageEntitlements-entitlementPlans-unitOfMeasureConversions-item-response

{
    "title":"Subscription Entitlement Plan UOM Conversions",
    "type":"array",
    "description":"The subscription entitlement plan UOM Conversions is used to store the conversion rates between various UOMs for all entitlement plans.",
    "items":{
        "$ref":"#/components/schemas/subscriptionUsageEntitlements-entitlementPlans-unitOfMeasureConversions-item-response"
    }
}

Nested Schema : Subscription Entitlement Pricing Rules

Type: array

Title: Subscription Entitlement Pricing Rules

The subscription entitlement plan charge rules resource is used to view, create, update, and delete an entitlement plan.

Show Source

• Array of: object subscriptionUsageEntitlements-entitlementPlans-volumePricingRules-item-response

{
    "title":"Subscription Entitlement Pricing Rules",
    "type":"array",
    "description":"The subscription entitlement plan charge rules resource is used to view, create, update, and delete an entitlement plan.",
    "items":{
        "$ref":"#/components/schemas/subscriptionUsageEntitlements-entitlementPlans-volumePricingRules-item-response"
    }
}

Nested Schema : subscriptionUsageEntitlements-entitlementPlans-allowances-item-response

Type: object

Show Source

• AdditionalPoolingFilter: string
  Title: Pooling Filter

  Maximum Length: 30

  The type of filter that needs to be applied on allowance pool.
• AllowanceChargeDefinitionId: integer (int64)
  Title: Allowance Charge Definition ID

  The unique identifier of charge definition of the subscription entitlement plan allowances.
• AllowancePeriodicity: string
  Title: Periodicity

  Maximum Length: 30

  The periodicity factor of allowance under subscription entitlement plan details.
• AllowancePoolingGroup: string
  Title: Pooling Group

  Maximum Length: 30

  The Pooling Group value that's specified for the additional pooling filter of allowance.
• AllowanceQuantity: number
  Title: Quantity

  The allowance quantity under subscription entitlement plan details.
• AllowanceRolloverPeriod: integer
  Title: Rollover Period

  The allowance rollover period under subscription entitlement plan details.
• AllowanceRolloverPeriodUnitOfMeasure: string
  Title: Rollover Period UOM

  Maximum Length: 3

  The unit of measure of allowance rollover under subscription entitlement plan details.
• AllowanceUnitOfMeasure: string
  Title: UOM

  Maximum Length: 3

  The unit of measure of allowance under subscription entitlement plan details.
• AllowanceValidityPeriod: integer
  Title: Validity Period

  The allowance validity period under subscription entitlement plan details.
• AllowanceValidityPeriodUnitOfMeasure: string
  Title: Validity Period UOM

  Maximum Length: 3

  The unit of measure of allowance validity under subscription entitlement plan details.
• Amount: number
  Title: Amount

  The amount under subscription entitlement plan details.
• BalanceCategoryCode: string
  Maximum Length: 30

  The lookup code which denotes the category of balance code for the entitlement plan detail.
• BalanceCategoryId: integer (int64)
  Title: Balance Category ID

  The unique identifier of balance profie category associated to the entitlement plan detail.
• BalanceCategoryName: string
  Title: Category Name

  Maximum Length: 80

  The lookup meaning of the balance category associated to the entitlement plan detail.
• BalanceCode: string
  Title: Balance Code

  Maximum Length: 30

  The balance code of subscription entitlement plan details.
• BalanceCodeDescription: string
  Title: Name

  Read Only: true

  Maximum Length: 120

  The description of balance code under subscription entitlement plan details.
• BalanceCodeId: integer (int64)
  Title: Balance Code ID

  The unique identifier of balance code under subscription entitlement plan details.
• BalanceCodeMaxPrecision: integer (int32)
  Title: Maximum Precision

  Read Only: true

  The maximum precision of balance code for the subscription entitlement plan details.
• BalanceCodeType: string
  Title: Balance Code Type

  Maximum Length: 30

  The balance code type of the subscription entitlement plan details.
• BalanceProfileId: integer (int64)
  Read Only: true

  The unique identifier of the balance profile of the allowance rating model setup for the product.
• ChargeDefinitionCode: string
  Maximum Length: 30

  The charge definition code under subscription entitlement plan details.
• ChargeDefinitionId: integer (int64)
  The unique identifier for charge definition under subscription entitlement plan details.
• ChargePriceType: string
  Title: Charge Type

  Maximum Length: 30

  The charge type of selected charge under subscription entitlement plan details.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who created the subscription entitlement plan details.
• CreationDate: string (date-time)
  Read Only: true

  The date of creation of the subscription entitlement plan details.
• CurrencyCode: string
  Title: Currency

  Maximum Length: 15

  The currency code of amount type balance code under subscription entitlement plan details.
• EntitlementPlanDetailId: integer (int64)
  The unique identifier of subscription entitlement plan details.
• EntitlementPlanDetailNumber: string
  Maximum Length: 120

  The unique number of subscription entitlement plan details.
• EntitlementPlanId: integer (int64)
  The unique identifier of subscription entitlement plan.
• ExtendedPrecision: integer (int32)
  Title: Extended Precision

  Read Only: true

  The actual extended precision of entitlement plan details.
• GrantEffectivityPeriodFrom: integer (int64)
  Title: Effectivity Period From

  The starting period from which the grant entitlement becomes effective under the subscription entitlement plan details.
• GrantEffectivityPeriodTo: integer (int64)
  Title: Effectivity Period To

  The ending period to which the grant entitlement remains effective under the subscription entitlement plan details.
• GrantEffectivityType: string
  Title: Effectivity Type

  Maximum Length: 30

  The type of effectivity that determines how the grant entitlement is applied under the subscription entitlement plan details.
• LastUpdateDate: string (date-time)
  Read Only: true

  The date when the subscription entitlement plan details was last updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who has last updated the subscription entitlement plan details.
• LastUpdateLogin: string
  Read Only: true

  Maximum Length: 32

  The login of the user who last updated the subscription entitlement plan details.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ObjectVersionNumber: integer (int32)
  The version number of subscription entitlement plan details.
• PERSubscriptionProductFlag: boolean
  Title: Per subscription product

  Maximum Length: 1

  Indicates if the allowance is for per quantity of subscription product or not.
• PoolAcrossRenewalsFlag: boolean
  Title: Pool across renewals

  Maximum Length: 1

  Indicates whether the allowance pool can be carried forward and applied across subscription renewals.
• PrecisionFactor: number
  Title: Rounding Factor

  Read Only: true

  The precision factor of subscription entitlement plan details.
• PrecisionType: string
  Title: Rounding Type

  Read Only: true

  Maximum Length: 30

  The precision type of subscription entitlement plan details.
• SubscriptionProductId: integer (int64)
  The subscription product identifier of subscription entitlement plan details.
• SubscriptionProductPuid: string
  Read Only: true

  Maximum Length: 120

  The alternate unique identifier of the subscription product associated with the subscription entitlement plan details.

{
    "type":"object",
    "properties":{
        "AdditionalPoolingFilter":{
            "title":"Pooling Filter",
            "maxLength":30,
            "type":"string",
            "description":"The type of filter that needs to be applied on allowance pool.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "AllowanceChargeDefinitionId":{
            "title":"Allowance Charge Definition ID",
            "type":"integer",
            "description":"The unique identifier of charge definition of the subscription entitlement plan allowances.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov",
                "precision":18
            },
            "x-queryable":true
        },
        "AllowancePeriodicity":{
            "title":"Periodicity",
            "maxLength":30,
            "type":"string",
            "description":"The periodicity factor of allowance under subscription entitlement plan details.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "AllowancePoolingGroup":{
            "title":"Pooling Group",
            "maxLength":30,
            "type":"string",
            "description":"The Pooling Group value that's specified for the additional pooling filter of allowance.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "AllowanceQuantity":{
            "title":"Quantity",
            "type":"number",
            "description":"The allowance quantity under subscription entitlement plan details.",
            "nullable":true,
            "x-queryable":true
        },
        "AllowanceRolloverPeriod":{
            "title":"Rollover Period",
            "type":"integer",
            "description":"The allowance rollover period under subscription entitlement plan details.",
            "nullable":true,
            "x-queryable":true
        },
        "AllowanceRolloverPeriodUnitOfMeasure":{
            "title":"Rollover Period UOM",
            "maxLength":3,
            "type":"string",
            "description":"The unit of measure of allowance rollover under subscription entitlement plan details.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "AllowanceUnitOfMeasure":{
            "title":"UOM",
            "maxLength":3,
            "type":"string",
            "description":"The unit of measure of allowance under subscription entitlement plan details.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "AllowanceValidityPeriod":{
            "title":"Validity Period",
            "type":"integer",
            "description":"The allowance validity period under subscription entitlement plan details.",
            "nullable":true,
            "x-queryable":true
        },
        "AllowanceValidityPeriodUnitOfMeasure":{
            "title":"Validity Period UOM",
            "maxLength":3,
            "type":"string",
            "description":"The unit of measure of allowance validity under subscription entitlement plan details.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "Amount":{
            "title":"Amount",
            "type":"number",
            "description":"The amount under subscription entitlement plan details.",
            "nullable":true,
            "x-queryable":true
        },
        "BalanceCategoryCode":{
            "maxLength":30,
            "type":"string",
            "description":"The lookup code which denotes the category of balance code for the entitlement plan detail.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "BalanceCategoryId":{
            "title":"Balance Category ID",
            "type":"integer",
            "description":"The unique identifier of balance profie category associated to the entitlement plan detail.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "BalanceCategoryName":{
            "title":"Category Name",
            "maxLength":80,
            "type":"string",
            "description":"The lookup meaning of the balance category associated to the entitlement plan detail.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "BalanceCode":{
            "title":"Balance Code",
            "maxLength":30,
            "type":"string",
            "description":"The balance code of subscription entitlement plan details.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "BalanceCodeDescription":{
            "title":"Name",
            "maxLength":120,
            "type":"string",
            "description":"The description of balance code under subscription entitlement plan details.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BalanceCodeId":{
            "title":"Balance Code ID",
            "type":"integer",
            "description":"The unique identifier of balance code under subscription entitlement plan details.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "BalanceCodeMaxPrecision":{
            "title":"Maximum Precision",
            "type":"integer",
            "description":"The maximum precision of balance code for the subscription entitlement plan details.",
            "format":"int32",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":2
            },
            "x-queryable":true
        },
        "BalanceCodeType":{
            "title":"Balance Code Type",
            "maxLength":30,
            "type":"string",
            "description":"The balance code type of the subscription entitlement plan details.",
            "nullable":true,
            "x-queryable":true
        },
        "BalanceProfileId":{
            "type":"integer",
            "description":"The unique identifier of the balance profile of the allowance rating model setup for the product.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ChargeDefinitionCode":{
            "maxLength":30,
            "type":"string",
            "description":"The charge definition code under subscription entitlement plan details.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "ChargeDefinitionId":{
            "type":"integer",
            "description":"The unique identifier for charge definition under subscription entitlement plan details.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ChargePriceType":{
            "title":"Charge Type",
            "maxLength":30,
            "type":"string",
            "description":"The charge type of selected charge under subscription entitlement plan details.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the subscription entitlement plan details.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date of creation of the subscription entitlement plan details.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CurrencyCode":{
            "title":"Currency",
            "maxLength":15,
            "type":"string",
            "description":"The currency code of amount type balance code under subscription entitlement plan details.",
            "nullable":true,
            "x-queryable":true
        },
        "EntitlementPlanDetailId":{
            "type":"integer",
            "description":"The unique identifier of subscription entitlement plan details.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "EntitlementPlanDetailNumber":{
            "maxLength":120,
            "type":"string",
            "description":"The unique number of subscription entitlement plan details.",
            "nullable":false,
            "x-queryable":true
        },
        "EntitlementPlanId":{
            "type":"integer",
            "description":"The unique identifier of subscription entitlement plan.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ExtendedPrecision":{
            "title":"Extended Precision",
            "type":"integer",
            "description":"The actual extended precision of entitlement plan details.",
            "format":"int32",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":2
            },
            "x-queryable":true
        },
        "GrantEffectivityPeriodFrom":{
            "title":"Effectivity Period From",
            "type":"integer",
            "description":"The starting period from which the grant entitlement becomes effective under the subscription entitlement plan details.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "GrantEffectivityPeriodTo":{
            "title":"Effectivity Period To",
            "type":"integer",
            "description":"The ending period to which the grant entitlement remains effective under the subscription entitlement plan details.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "GrantEffectivityType":{
            "title":"Effectivity Type",
            "maxLength":30,
            "type":"string",
            "description":"The type of effectivity that determines how the grant entitlement is applied under the subscription entitlement plan details.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date when the subscription entitlement plan details was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"The login of the user who last updated the subscription entitlement plan details.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who has last updated the subscription entitlement plan details.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"The version number of subscription entitlement plan details.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "PERSubscriptionProductFlag":{
            "title":"Per subscription product",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates if the allowance is for per quantity of subscription product or not.",
            "nullable":true,
            "x-queryable":false
        },
        "PoolAcrossRenewalsFlag":{
            "title":"Pool across renewals",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the allowance pool can be carried forward and applied across subscription renewals.",
            "nullable":true,
            "x-queryable":true
        },
        "PrecisionFactor":{
            "title":"Rounding Factor",
            "type":"number",
            "description":"The precision factor of subscription entitlement plan details.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PrecisionType":{
            "title":"Rounding Type",
            "maxLength":30,
            "type":"string",
            "description":"The precision type of subscription entitlement plan details.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SubscriptionProductId":{
            "type":"integer",
            "description":"The subscription product identifier of subscription entitlement plan details.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SubscriptionProductPuid":{
            "maxLength":120,
            "type":"string",
            "description":"The alternate unique identifier of the subscription product associated with the subscription entitlement plan details.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• href: string
  Title: hyperlink reference

  The URI to the related resource.
• kind: string
  Title: kind

  Allowed Values: [ "collection", "item", "describe", "other" ]

  The kind of the related resource.
• name: string
  Title: name

  The name of the link to the related resource.
• properties: object properties
• rel: string
  Title: relation

  Allowed Values: [ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]

  The name of the relation to the resource instance. Example: self.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Nested Schema : subscriptionUsageEntitlements-entitlementPlans-commitments-item-response

Type: object

Show Source

• Amount: number
  Title: Amount

  The amount of the subscription entitlement plan commitments.
• BalanceCode: string
  Title: Balance Code

  Maximum Length: 30

  The balance code of the subscription entitlement plan commitments.
• BalanceCodeId: integer (int64)
  Title: Balance Code ID

  The unique identifier of balance code of the subscription entitlement plan commitments.
• BalanceCodeMaxPrecision: integer (int32)
  Title: Maximum Precision

  Read Only: true

  The maximum precision of balance code of the subscription entitlement plan commitments.
• BalanceCodeType: string
  Title: Balance Code Type

  Maximum Length: 30

  The balance code type of the subscription entitlement plan commitments.
• BalanceProfileId: integer (int64)
  Read Only: true

  The unique identifier of the balance profile of the commitment rating model setup for the product.
• ChargeDefinitionCode: string
  Maximum Length: 30

  The charge definition code of the subscription entitlement plan commitments.
• ChargeDefinitionId: integer (int64)
  The unique identifier of charge definition of the subscription entitlement plan commitments.
• ChargePriceType: string
  Title: Charge Type

  Maximum Length: 30

  The charge type of selected charge under subscription entitlement plan commitments.
• CommitmentChargeDefinitionId: integer (int64)
  Title: Commitment Charge Definition ID

  The unique identifier of charge definition of the subscription entitlement plan commitments.
• CommitmentRelatedChargeDefinitionId: integer (int64)
  Title: Commitment Related Charge Definition ID

  The unique identifier of related charge definition of the subscription entitlement plan commitments.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who created the subscription entitlement plan commitments.
• CreationDate: string (date-time)
  Read Only: true

  The date of creation of the subscription entitlement plan commitments.
• CurrencyCode: string
  Title: Currency Code

  Maximum Length: 15

  The currency code of the subscription entitlement plan commitments.
• EntitlementPlanCommitmentId: integer (int64)
  The unique identifier of entitlement plan commitments.
• EntitlementPlanCommitmentNumber: string
  Maximum Length: 120

  The unique number of entitlement plan commitments.
• EntitlementPlanId: integer (int64)
  The unique identifier of entitlement plan of the subscription entitlement plan commitments.
• ExtendedPrecision: integer (int32)
  Title: Extended Precision

  Read Only: true

  The actual extended precision of entitlement plan commitments.
• LastUpdateDate: string (date-time)
  Read Only: true

  The date when the subscription entitlement plan commitments was last updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who last updated the subscription entitlement plan commitments.
• LastUpdateLogin: string
  Read Only: true

  Maximum Length: 32

  The login of the user who last updated the subscription entitlement plan commitments.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ObjectVersionNumber: integer (int32)
  Read Only: true

  The version number of the subscription entitlement plan commitments.
• Period: string
  Title: Periodicity

  The period of the subscription entitlement plan commitments.
• Quantity: number
  Title: Quantity

  The quantity of the subscription entitlement plan commitments.
• RelatedChargeDefinitionCode: string
  Maximum Length: 30

  The charge definition code of the related charge identifier.
• RelatedChargeDefinitionId: integer (int64)
  The unique identifier of charge definition of the related charge.
• RelatedChargePriceType: string
  Title: Charge Type

  Maximum Length: 30

  The charge type of selected related charge under subscription entitlement plan commitments.
• RelatedPeriod: string
  Title: Related Charge Periodicity

  The related period of the related charge. Indicates the related charge name from which the estimates or commitments are granted.
• RoundedQuantity: number
  Title: Rounded Quantity

  The rounded quantity of the subscription entitlement plan commitments.
• SubscriptionProductId: integer (int64)
  The unique identifier of subscription product of the subscription entitlement plan commitments.
• SubscriptionProductPuid: string
  Read Only: true

  Maximum Length: 120

  The alternate unique identifier of the subscription product associated with the subscription entitlement plan commitments.
• UnitOfMeasure: string
  Title: UOM

  Maximum Length: 3

  The unit of measure of the subscription entitlement plan commitments.

{
    "type":"object",
    "properties":{
        "Amount":{
            "title":"Amount",
            "type":"number",
            "description":"The amount of the subscription entitlement plan commitments.",
            "nullable":true,
            "x-queryable":true
        },
        "BalanceCode":{
            "title":"Balance Code",
            "maxLength":30,
            "type":"string",
            "description":"The balance code of the subscription entitlement plan commitments.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "BalanceCodeId":{
            "title":"Balance Code ID",
            "type":"integer",
            "description":"The unique identifier of balance code of the subscription entitlement plan commitments.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "BalanceCodeMaxPrecision":{
            "title":"Maximum Precision",
            "type":"integer",
            "description":"The maximum precision of balance code of the subscription entitlement plan commitments.",
            "format":"int32",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":2
            },
            "x-queryable":true
        },
        "BalanceCodeType":{
            "title":"Balance Code Type",
            "maxLength":30,
            "type":"string",
            "description":"The balance code type of the subscription entitlement plan commitments.",
            "nullable":true,
            "x-queryable":true
        },
        "BalanceProfileId":{
            "type":"integer",
            "description":"The unique identifier of the balance profile of the commitment rating model setup for the product.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ChargeDefinitionCode":{
            "maxLength":30,
            "type":"string",
            "description":"The charge definition code of the subscription entitlement plan commitments.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "ChargeDefinitionId":{
            "type":"integer",
            "description":"The unique identifier of charge definition of the subscription entitlement plan commitments.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ChargePriceType":{
            "title":"Charge Type",
            "maxLength":30,
            "type":"string",
            "description":"The charge type of selected charge under subscription entitlement plan commitments.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "CommitmentChargeDefinitionId":{
            "title":"Commitment Charge Definition ID",
            "type":"integer",
            "description":"The unique identifier of charge definition of the subscription entitlement plan commitments.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            },
            "x-queryable":true
        },
        "CommitmentRelatedChargeDefinitionId":{
            "title":"Commitment Related Charge Definition ID",
            "type":"integer",
            "description":"The unique identifier of related charge definition of the subscription entitlement plan commitments.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the subscription entitlement plan commitments.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date of creation of the subscription entitlement plan commitments.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CurrencyCode":{
            "title":"Currency Code",
            "maxLength":15,
            "type":"string",
            "description":"The currency code of the subscription entitlement plan commitments.",
            "nullable":true,
            "x-queryable":true
        },
        "EntitlementPlanCommitmentId":{
            "type":"integer",
            "description":"The unique identifier of entitlement plan commitments.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "EntitlementPlanCommitmentNumber":{
            "maxLength":120,
            "type":"string",
            "description":"The unique number of entitlement plan commitments.",
            "nullable":true,
            "x-queryable":true
        },
        "EntitlementPlanId":{
            "type":"integer",
            "description":"The unique identifier of entitlement plan of the subscription entitlement plan commitments.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ExtendedPrecision":{
            "title":"Extended Precision",
            "type":"integer",
            "description":"The actual extended precision of entitlement plan commitments.",
            "format":"int32",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":2
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date when the subscription entitlement plan commitments was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"The login of the user who last updated the subscription entitlement plan commitments.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the subscription entitlement plan commitments.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"The version number of the subscription entitlement plan commitments.",
            "format":"int32",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "Period":{
            "title":"Periodicity",
            "type":"string",
            "description":"The period of the subscription entitlement plan commitments.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "Quantity":{
            "title":"Quantity",
            "type":"number",
            "description":"The quantity of the subscription entitlement plan commitments.",
            "nullable":true,
            "x-queryable":true
        },
        "RelatedChargeDefinitionCode":{
            "maxLength":30,
            "type":"string",
            "description":"The charge definition code of the related charge identifier.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "RelatedChargeDefinitionId":{
            "type":"integer",
            "description":"The unique identifier of charge definition of the related charge.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "RelatedChargePriceType":{
            "title":"Charge Type",
            "maxLength":30,
            "type":"string",
            "description":"The charge type of selected related charge under subscription entitlement plan commitments.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "RelatedPeriod":{
            "title":"Related Charge Periodicity",
            "type":"string",
            "description":"The related period of the related charge. Indicates the related charge name from which the estimates or commitments are granted.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "sortable":false
            }
        },
        "RoundedQuantity":{
            "title":"Rounded Quantity",
            "type":"number",
            "description":"The rounded quantity of the subscription entitlement plan commitments.",
            "nullable":true,
            "x-queryable":true
        },
        "SubscriptionProductId":{
            "type":"integer",
            "description":"The unique identifier of subscription product of the subscription entitlement plan commitments.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SubscriptionProductPuid":{
            "maxLength":120,
            "type":"string",
            "description":"The alternate unique identifier of the subscription product associated with the subscription entitlement plan commitments.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "UnitOfMeasure":{
            "title":"UOM",
            "maxLength":3,
            "type":"string",
            "description":"The unit of measure of the subscription entitlement plan commitments.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : subscriptionUsageEntitlements-entitlementPlans-estimates-item-response

Type: object

Show Source

• Amount: number
  Title: Amount

  The amount of the subscription entitlement plan estimates.
• BalanceCode: string
  Title: Balance Code

  Maximum Length: 30

  The balance code of the subscription entitlement plan estimates.
• BalanceCodeId: integer (int64)
  Title: Balance Code ID

  The unique identifier of balance code of the subscription entitlement plan estimates.
• BalanceCodeMaxPrecision: integer (int32)
  Title: Maximum Precision

  Read Only: true

  The maximum precision of balance code for the subscription entitlement plan estimates.
• BalanceCodeType: string
  Title: Balance Code Type

  Maximum Length: 30

  The balance code type of the subscription entitlement plan estimates.
• BalanceProfileId: integer (int64)
  Read Only: true

  The unique identifier of the balance profile of the estimate rating model setup for the product.
• ChargeDefinitionCode: string
  Maximum Length: 30

  The charge definition code of the subscription entitlement plan estimates.
• ChargeDefinitionId: integer (int64)
  The unique identifier of charge definition of the subscription entitlement plan estimates.
• ChargePeriod: string
  Title: Estimate Period

  The estimate period of the subscription entitlement plan estimates.
• ChargePriceType: string
  Title: Charge Type

  Maximum Length: 30

  The charge type of selected charge under subscription entitlement plan estimates.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who created the subscription entitlement plan estimates.
• CreationDate: string (date-time)
  Read Only: true

  The date when the subscription entitlement plan estimates was created.
• CurrencyCode: string
  Title: Currency Code

  Maximum Length: 15

  The currency code of the subscription entitlement plan estimates.
• EnableRolloverFlag: boolean
  Title: Enable rollover

  Maximum Length: 1

  Default Value: false

  Indicates whether the rollover is enabled for the subscription entitlement plan estimates.
• EntitlementPlanEstimateId: integer (int64)
  The unique identifier of the subscription entitlement plan estimates.
• EntitlementPlanEstimateNumber: string
  Maximum Length: 120

  The unique number of entitlement plan estimates.
• EntitlementPlanId: integer (int64)
  The unique identifier of entitlement plan of the subscription entitlement plan estimates.
• EstimateChargeDefinitionId: integer (int64)
  Title: Estimate Charge Definition ID

  The unique identifier of charge definition of the subscription entitlement plan estimates.
• EstimateRelatedChargeDefinitionId: integer (int64)
  Title: Estimate Related Charge Definition ID

  The unique identifier of related charge definition of the subscription entitlement plan estimates.
• ExtendedPrecision: integer (int32)
  Title: Extended Precision

  Read Only: true

  The actual extended precision of entitlement plan estimates.
• LastUpdateDate: string (date-time)
  Read Only: true

  The date when the subscription entitlement plan estimates was last updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who has last updated the subscription entitlement plan estimates.
• LastUpdateLogin: string
  Read Only: true

  Maximum Length: 32

  The login of the user who last updated the subscription entitlement plan estimates.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ObjectVersionNumber: integer (int32)
  Read Only: true

  The version number of the subscription entitlement plan estimates.
• Period: string
  Title: Periodicity

  The period of the subscription entitlement plan estimates.
• Quantity: number
  Title: Quantity

  The quantity of the subscription entitlement plan estimates.
• RelatedChargeDefinitionCode: string
  Title: Related Charge

  Maximum Length: 30

  The charge definition code of the related charge identifier.
• RelatedChargeDefinitionId: integer (int64)
  The unique identifier of charge definition of the related charge.
• RelatedChargePriceType: string
  Title: Charge Type

  Maximum Length: 30

  The charge type of selected related charge under subscription entitlement plan estimates.
• RelatedPeriod: string
  Title: Related Charge Periodicity

  The related period of the related charge. Indicates the related charge name from which the estimates or commitments are granted.
• RolloverPeriod: integer
  Title: Rollover Period

  The rollover period of the subscription entitlement plan estimates.
• RolloverPeriodUnitOfMeasure: string
  Title: Rollover Period UOM

  Maximum Length: 3

  The rollover period unit of measure of the subscription entitlement plan estimates.
• RoundedQuantity: number
  Title: Rounded Quantity

  The rounded quantity of the subscription entitlement plan estimates.
• SubscriptionProductId: integer (int64)
  The unique identifier of subscription product of the subscription entitlement plan estimates.
• SubscriptionProductPuid: string
  Read Only: true

  Maximum Length: 120

  The alternate unique identifier of the subscription product associated with the subscription entitlement plan estimates.
• TrueupOverageFlag: boolean
  Title: True-up overage

  Maximum Length: 1

  Default Value: true

  Indicates whether a overage is enabled for a given usage charge.
• TrueupShortageFlag: boolean
  Title: True-up shortage

  Maximum Length: 1

  Default Value: true

  Indicates whether a shortage is enabled for a given usage charge.
• UnitOfMeasure: string
  Title: UOM

  Maximum Length: 3

  The unit of measure of the subscription entitlement plan estimates.

{
    "type":"object",
    "properties":{
        "Amount":{
            "title":"Amount",
            "type":"number",
            "description":"The amount of the subscription entitlement plan estimates.",
            "nullable":true,
            "x-queryable":true
        },
        "BalanceCode":{
            "title":"Balance Code",
            "maxLength":30,
            "type":"string",
            "description":"The balance code of the subscription entitlement plan estimates.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "BalanceCodeId":{
            "title":"Balance Code ID",
            "type":"integer",
            "description":"The unique identifier of balance code of the subscription entitlement plan estimates.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "BalanceCodeMaxPrecision":{
            "title":"Maximum Precision",
            "type":"integer",
            "description":"The maximum precision of balance code for the subscription entitlement plan estimates.",
            "format":"int32",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":2
            },
            "x-queryable":true
        },
        "BalanceCodeType":{
            "title":"Balance Code Type",
            "maxLength":30,
            "type":"string",
            "description":"The balance code type of the subscription entitlement plan estimates.",
            "nullable":true,
            "x-queryable":true
        },
        "BalanceProfileId":{
            "type":"integer",
            "description":"The unique identifier of the balance profile of the estimate rating model setup for the product.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ChargeDefinitionCode":{
            "maxLength":30,
            "type":"string",
            "description":"The charge definition code of the subscription entitlement plan estimates.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "ChargeDefinitionId":{
            "type":"integer",
            "description":"The unique identifier of charge definition of the subscription entitlement plan estimates.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ChargePeriod":{
            "title":"Estimate Period",
            "type":"string",
            "description":"The estimate period of the subscription entitlement plan estimates.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "sortable":false
            }
        },
        "ChargePriceType":{
            "title":"Charge Type",
            "maxLength":30,
            "type":"string",
            "description":"The charge type of selected charge under subscription entitlement plan estimates.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the subscription entitlement plan estimates.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date when the subscription entitlement plan estimates was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CurrencyCode":{
            "title":"Currency Code",
            "maxLength":15,
            "type":"string",
            "description":"The currency code of the subscription entitlement plan estimates.",
            "nullable":true,
            "x-queryable":true
        },
        "EnableRolloverFlag":{
            "title":"Enable rollover",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the rollover is enabled for the subscription entitlement plan estimates.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "EntitlementPlanEstimateId":{
            "type":"integer",
            "description":"The unique identifier of the subscription entitlement plan estimates.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "EntitlementPlanEstimateNumber":{
            "maxLength":120,
            "type":"string",
            "description":"The unique number of entitlement plan estimates.",
            "nullable":false,
            "x-queryable":true
        },
        "EntitlementPlanId":{
            "type":"integer",
            "description":"The unique identifier of entitlement plan of the subscription entitlement plan estimates.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "EstimateChargeDefinitionId":{
            "title":"Estimate Charge Definition ID",
            "type":"integer",
            "description":"The unique identifier of charge definition of the subscription entitlement plan estimates.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            },
            "x-queryable":true
        },
        "EstimateRelatedChargeDefinitionId":{
            "title":"Estimate Related Charge Definition ID",
            "type":"integer",
            "description":"The unique identifier of related charge definition of the subscription entitlement plan estimates.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            },
            "x-queryable":true
        },
        "ExtendedPrecision":{
            "title":"Extended Precision",
            "type":"integer",
            "description":"The actual extended precision of entitlement plan estimates.",
            "format":"int32",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":2
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date when the subscription entitlement plan estimates was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"The login of the user who last updated the subscription entitlement plan estimates.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who has last updated the subscription entitlement plan estimates.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"The version number of the subscription entitlement plan estimates.",
            "format":"int32",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "Period":{
            "title":"Periodicity",
            "type":"string",
            "description":"The period of the subscription entitlement plan estimates.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "Quantity":{
            "title":"Quantity",
            "type":"number",
            "description":"The quantity of the subscription entitlement plan estimates.",
            "nullable":true,
            "x-queryable":true
        },
        "RelatedChargeDefinitionCode":{
            "title":"Related Charge",
            "maxLength":30,
            "type":"string",
            "description":"The charge definition code of the related charge identifier.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "RelatedChargeDefinitionId":{
            "type":"integer",
            "description":"The unique identifier of charge definition of the related charge.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "RelatedChargePriceType":{
            "title":"Charge Type",
            "maxLength":30,
            "type":"string",
            "description":"The charge type of selected related charge under subscription entitlement plan estimates.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "RelatedPeriod":{
            "title":"Related Charge Periodicity",
            "type":"string",
            "description":"The related period of the related charge. Indicates the related charge name from which the estimates or commitments are granted.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "sortable":false
            }
        },
        "RolloverPeriod":{
            "title":"Rollover Period",
            "type":"integer",
            "description":"The rollover period of the subscription entitlement plan estimates.",
            "nullable":true,
            "x-queryable":true
        },
        "RolloverPeriodUnitOfMeasure":{
            "title":"Rollover Period UOM",
            "maxLength":3,
            "type":"string",
            "description":"The rollover period unit of measure of the subscription entitlement plan estimates.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "RoundedQuantity":{
            "title":"Rounded Quantity",
            "type":"number",
            "description":"The rounded quantity of the subscription entitlement plan estimates.",
            "nullable":true,
            "x-queryable":true
        },
        "SubscriptionProductId":{
            "type":"integer",
            "description":"The unique identifier of subscription product of the subscription entitlement plan estimates.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SubscriptionProductPuid":{
            "maxLength":120,
            "type":"string",
            "description":"The alternate unique identifier of the subscription product associated with the subscription entitlement plan estimates.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "TrueupOverageFlag":{
            "title":"True-up overage",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether a overage is enabled for a given usage charge.",
            "nullable":true,
            "default":true,
            "x-queryable":true
        },
        "TrueupShortageFlag":{
            "title":"True-up shortage",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether a shortage is enabled for a given usage charge.",
            "nullable":true,
            "default":true,
            "x-queryable":true
        },
        "UnitOfMeasure":{
            "title":"UOM",
            "maxLength":3,
            "type":"string",
            "description":"The unit of measure of the subscription entitlement plan estimates.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : subscriptionUsageEntitlements-entitlementPlans-unitOfMeasureConversions-item-response

Type: object

Show Source

• ActiveFlag: boolean
  Title: Active

  Maximum Length: 1

  Indicates whether the UOM conversion row is active or not.
• BalanceCode: string
  Title: Balance Code

  Maximum Length: 30

  Indicates the balance code name of the UOM conversion.
• BalanceCodeId: integer (int64)
  Title: Balance Code ID

  The unique identifier of balance code identifier associated to the UOM conversion.
• BalanceProfileId: integer (int64)
  Title: Balance Profile ID

  The unique identifier of balance profile identifier associated to the UOM conversion.
• BalanceUnitofMeasureClassCode: string
  Title: Unit of Measure Class

  Read Only: true

  Maximum Length: 10

  The balance unit of measure class code of the subscription balance code.
• ChargeDefinitionCode: string
  Title: Charge Definition

  Maximum Length: 30

  The charge definition code associated to the UOM conversion.
• ChargeDefinitionId: integer
  Title: Charge Definition ID

  The unique identifier of charge definition identifier associated to the UOM conversion.
• ChargeName: string
  Title: Charge

  Maximum Length: 80

  The name of the charge associated to the UOM conversion.
• ChargePriceType: string
  Title: Charge Type

  Read Only: true

  Maximum Length: 30

  The charge type of selected charge associated to the UOM conversion.
• ChargeUOMCode: string
  Title: Charge UOM

  Maximum Length: 3

  The code of the charge associated to the UOM conversion.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who created the subscription entitlement plan UOM conversions.
• CreationDate: string (date-time)
  Read Only: true

  The date of creation of the subscription entitlement plan UOM conversions.
• EndDate: string (date)
  Title: End Date

  The end date till the UOM conversion row remains active.
• EntitlementPlanId: integer (int64)
  Title: Entitlement Plan ID

  The unique identifier of entitlement plan identifier associated to the UOM conversion.
• EntitlementPlanUOMConversionId: integer (int64)
  Title: UOM Conversion ID

  The unique identifier of entitlement plan UOM conversions.
• EntitlementPlanUOMConversionNumber: string
  Title: UOM Conversion Number

  Maximum Length: 120

  The unique number of entitlement plan UOM conversions.
• LastUpdateDate: string (date-time)
  Read Only: true

  The date when the subscription entitlement plan UOM conversion was last updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who last updated the subscription entitlement plan UOM conversions.
• LastUpdateLogin: string
  Read Only: true

  Maximum Length: 32

  The login of the user who last updated the subscription entitlement plan UOM conversions.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ObjectVersionNumber: integer (int32)
  Read Only: true

  The version number of the subscription entitlement plan UOM conversions.
• ProductEntitlementPlanId: integer (int64)
  Title: Product Entitlement Plan ID

  The unique identifier of the product entitlement plan record of UOM conversions.
• StartDate: string (date)
  Title: Start Date

  The start date from the UOM conversion row starts active.
• SubscriptionProductId: integer (int64)
  Title: Subscription Product ID

  The unique identifier of the subscription product of UOM conversions.
• SubscriptionProductPuid: string
  Read Only: true

  Maximum Length: 120

  The unique number of the subscription product of UOM conversions.
• UnitOfMeasure: string
  Title: Unit of Measure

  Maximum Length: 25

  The name of the unit of measure provided by user for UOM conversions.
• UOMChargeDefinitionId: integer
  Title: UOM Charge Definition ID

  The unique identifier of charge definition identifier of the UOM conversion.
• UOMCode: string
  Title: UOM

  Maximum Length: 3

  The code of the unit of measure provided by user for UOM conversions.
• UOMConversionRate: number
  Title: Conversion Rate

  The conversion rate of UOM code to charge UOM code.

{
    "type":"object",
    "properties":{
        "ActiveFlag":{
            "title":"Active",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the UOM conversion row is active or not.",
            "nullable":true,
            "x-queryable":false
        },
        "BalanceCode":{
            "title":"Balance Code",
            "maxLength":30,
            "type":"string",
            "description":"Indicates the balance code name of the UOM conversion.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "BalanceCodeId":{
            "title":"Balance Code ID",
            "type":"integer",
            "description":"The unique identifier of balance code identifier associated to the UOM conversion.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "BalanceProfileId":{
            "title":"Balance Profile ID",
            "type":"integer",
            "description":"The unique identifier of balance profile identifier associated to the UOM conversion.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "BalanceUnitofMeasureClassCode":{
            "title":"Unit of Measure Class",
            "maxLength":10,
            "type":"string",
            "description":"The balance unit of measure class code of the subscription balance code.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ChargeDefinitionCode":{
            "title":"Charge Definition",
            "maxLength":30,
            "type":"string",
            "description":"The charge definition code associated to the UOM conversion.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "ChargeDefinitionId":{
            "title":"Charge Definition ID",
            "type":"integer",
            "description":"The unique identifier of charge definition identifier associated to the UOM conversion.",
            "nullable":true,
            "x-queryable":false
        },
        "ChargeName":{
            "title":"Charge",
            "maxLength":80,
            "type":"string",
            "description":"The name of the charge associated to the UOM conversion.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "ChargePriceType":{
            "title":"Charge Type",
            "maxLength":30,
            "type":"string",
            "description":"The charge type of selected charge associated to the UOM conversion.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ChargeUOMCode":{
            "title":"Charge UOM",
            "maxLength":3,
            "type":"string",
            "description":"The code of the charge associated to the UOM conversion.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the subscription entitlement plan UOM conversions.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "CreationDate":{
            "type":"string",
            "description":"The date of creation of the subscription entitlement plan UOM conversions.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "EndDate":{
            "title":"End Date",
            "type":"string",
            "description":"The end date till the UOM conversion row remains active.",
            "format":"date",
            "nullable":true,
            "x-queryable":false
        },
        "EntitlementPlanId":{
            "title":"Entitlement Plan ID",
            "type":"integer",
            "description":"The unique identifier of entitlement plan identifier associated to the UOM conversion.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "EntitlementPlanUOMConversionId":{
            "title":"UOM Conversion ID",
            "type":"integer",
            "description":"The unique identifier of entitlement plan UOM conversions.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "EntitlementPlanUOMConversionNumber":{
            "title":"UOM Conversion Number",
            "maxLength":120,
            "type":"string",
            "description":"The unique number of entitlement plan UOM conversions.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date when the subscription entitlement plan UOM conversion was last updated.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"The login of the user who last updated the subscription entitlement plan UOM conversions.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the subscription entitlement plan UOM conversions.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"The version number of the subscription entitlement plan UOM conversions.",
            "format":"int32",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "ProductEntitlementPlanId":{
            "title":"Product Entitlement Plan ID",
            "type":"integer",
            "description":"The unique identifier of the product entitlement plan record of UOM conversions.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "StartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"The start date from the UOM conversion row starts active.",
            "format":"date",
            "nullable":true,
            "x-queryable":false
        },
        "SubscriptionProductId":{
            "title":"Subscription Product ID",
            "type":"integer",
            "description":"The unique identifier of the subscription product of UOM conversions.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "SubscriptionProductPuid":{
            "maxLength":120,
            "type":"string",
            "description":"The unique number of the subscription product of UOM conversions.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "UOMChargeDefinitionId":{
            "title":"UOM Charge Definition ID",
            "type":"integer",
            "description":"The unique identifier of charge definition identifier of the UOM conversion.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "UOMCode":{
            "title":"UOM",
            "maxLength":3,
            "type":"string",
            "description":"The code of the unit of measure provided by user for UOM conversions.",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "UOMConversionRate":{
            "title":"Conversion Rate",
            "type":"number",
            "description":"The conversion rate of UOM code to charge UOM code.",
            "nullable":false,
            "x-queryable":false
        },
        "UnitOfMeasure":{
            "title":"Unit of Measure",
            "maxLength":25,
            "type":"string",
            "description":"The name of the unit of measure provided by user for UOM conversions.",
            "nullable":false,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : subscriptionUsageEntitlements-entitlementPlans-volumePricingRules-item-response

Type: object

Show Source

• AggregationBalanceCode: string
  Title: Aggregation Balance Code

  Maximum Length: 30

  The balance code which is eligible for aggregation rating.
• AggregationBalanceCodeId: integer (int64)
  Title: Aggregation Balance Code ID

  The unique identifier of the balance code which is eligible for aggregation rating.
• AggregationPeriod: string
  Title: Aggregation Period

  Maximum Length: 30

  The charge period of balance code for volume rating.
• BalanceCode: string
  Title: Balance Code

  Maximum Length: 30

  The balance code which is eligible for volume rating.
• BalanceCodeId: integer (int64)
  The unique identifier of the balance code which is eligible for volume rating.
• BalanceCodeUnitOfMeasure: string
  Title: UOM

  Maximum Length: 3

  The unit of measure of balance code for volume rating.
• BalanceProfileId: integer (int64)
  Title: Balance Profile ID

  The unique identifier of the subscription balance profile.
• ChargeDefinitionCode: string
  Maximum Length: 30

  The charge definition code of the entitlement plan detail charge definition.
• ChargeDefinitionId: integer (int64)
  Title: Charge Definition ID

  The unique identifier of charge definition of the subscription entitlement plan commitments.
• ChargePriceType: string
  Title: Charge Type

  Maximum Length: 30

  The charge type of selected charge associated to the subscription entitlement plan charge rule.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The user who created the subscription entitlement plan commitments.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date of creation of the subscription entitlement plan commitments.
• EligibilityBalanceCodeId: integer (int64)
  Title: Eligible Balance Code ID

  The unique identifier of the balance code which is eligible for volume rating.
• EntitlementPlanChargeRuleId: integer (int64)
  Title: Profile Charge Rule ID

  The unique identifier of the subscription entitlement plan charge rule.
• EntitlementPlanChargeRuleNumber: string
  Title: Charge Rule Number

  Maximum Length: 120

  The unique number of the subscription entitlement plan charge rule.
• EntitlementPlanId: integer (int64)
  Title: Entitlement Plan ID

  The unique identifier of entitlement plan of the subscription entitlement plan.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The date when the subscription entitlement plan commitments was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The user who last updated the subscription entitlement plan commitments.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ObjectVersionNumber: integer (int32)
  Title: Object Version Number

  The version number of the subscription entitlement plan commitments.
• PricingBalanceCode: string
  Title: Pricing Balance Code

  Maximum Length: 30

  The balance code which is eligible for volume rating.
• ProductEntitlementPlanId: integer (int64)
  Title: Product Entitlement Plan ID

  The unique identifier of entitlement plan product of the subscription entitlement plan.
• SubscriptionProductId: integer (int64)
  Title: Subscription Product ID

  The unique identifier of subscription product.
• SubscriptionProductPuid: string
  Read Only: true

  Maximum Length: 120

  The alternate unique identifier of the subscription product associated with the volume pricing.
• VolumePricingAggregationFlag: boolean
  Title: Eligible for aggregation

  Maximum Length: 1

  Indicates whether the balance code is for enable aggregation rule of volume pricing.
• VolumePricingChargeDefinitionId: integer (int64)
  Title: Volume Pricing Charge Definition ID

  The unique identifier of charge definition of the subscription volume pricing.
• VolumePricingEligibilityFlag: boolean
  Title: Eligible for volume pricing

  Maximum Length: 1

  Indicates whether the balance code is for enable eligibility rule of volume pricing.

{
    "type":"object",
    "properties":{
        "AggregationBalanceCode":{
            "title":"Aggregation Balance Code",
            "maxLength":30,
            "type":"string",
            "description":"The balance code which is eligible for aggregation rating.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "AggregationBalanceCodeId":{
            "title":"Aggregation Balance Code ID",
            "type":"integer",
            "description":"The unique identifier of the balance code which is eligible for aggregation rating.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18,
                "dependencies":[
                    "VolumePricingAggregationFlag"
                ]
            },
            "x-queryable":true
        },
        "AggregationPeriod":{
            "title":"Aggregation Period",
            "maxLength":30,
            "type":"string",
            "description":"The charge period of balance code for volume rating.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "BalanceCode":{
            "title":"Balance Code",
            "maxLength":30,
            "type":"string",
            "description":"The balance code which is eligible for volume rating.",
            "nullable":false,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "BalanceCodeId":{
            "type":"integer",
            "description":"The unique identifier of the balance code which is eligible for volume rating.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "dependencies":[
                    "ChargeDefinitionId"
                ]
            },
            "x-queryable":true
        },
        "BalanceCodeUnitOfMeasure":{
            "title":"UOM",
            "maxLength":3,
            "type":"string",
            "description":"The unit of measure of balance code for volume rating.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "BalanceProfileId":{
            "title":"Balance Profile ID",
            "type":"integer",
            "description":"The unique identifier of the subscription balance profile.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ChargeDefinitionCode":{
            "maxLength":30,
            "type":"string",
            "description":"The charge definition code of the entitlement plan detail charge definition.",
            "nullable":false,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "ChargeDefinitionId":{
            "title":"Charge Definition ID",
            "type":"integer",
            "description":"The unique identifier of charge definition of the subscription entitlement plan commitments.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ChargePriceType":{
            "title":"Charge Type",
            "maxLength":30,
            "type":"string",
            "description":"The charge type of selected charge associated to the subscription entitlement plan charge rule.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the subscription entitlement plan commitments.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date of creation of the subscription entitlement plan commitments.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "EligibilityBalanceCodeId":{
            "title":"Eligible Balance Code ID",
            "type":"integer",
            "description":"The unique identifier of the balance code which is eligible for volume rating.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18,
                "dependencies":[
                    "VolumePricingEligibilityFlag"
                ]
            },
            "x-queryable":true
        },
        "EntitlementPlanChargeRuleId":{
            "title":"Profile Charge Rule ID",
            "type":"integer",
            "description":"The unique identifier of the subscription entitlement plan charge rule.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "EntitlementPlanChargeRuleNumber":{
            "title":"Charge Rule Number",
            "maxLength":120,
            "type":"string",
            "description":"The unique number of the subscription entitlement plan charge rule.",
            "nullable":true,
            "x-queryable":true
        },
        "EntitlementPlanId":{
            "title":"Entitlement Plan ID",
            "type":"integer",
            "description":"The unique identifier of entitlement plan of the subscription entitlement plan.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date when the subscription entitlement plan commitments was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the subscription entitlement plan commitments.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "title":"Object Version Number",
            "type":"integer",
            "description":"The version number of the subscription entitlement plan commitments.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "PricingBalanceCode":{
            "title":"Pricing Balance Code",
            "maxLength":30,
            "type":"string",
            "description":"The balance code which is eligible for volume rating.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "ProductEntitlementPlanId":{
            "title":"Product Entitlement Plan ID",
            "type":"integer",
            "description":"The unique identifier of entitlement plan product of the subscription entitlement plan.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SubscriptionProductId":{
            "title":"Subscription Product ID",
            "type":"integer",
            "description":"The unique identifier of subscription product.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SubscriptionProductPuid":{
            "maxLength":120,
            "type":"string",
            "description":"The alternate unique identifier of the subscription product associated with the volume pricing.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "VolumePricingAggregationFlag":{
            "title":"Eligible for aggregation",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the balance code is for enable aggregation rule of volume pricing.",
            "nullable":true,
            "x-queryable":true
        },
        "VolumePricingChargeDefinitionId":{
            "title":"Volume Pricing Charge Definition ID",
            "type":"integer",
            "description":"The unique identifier of charge definition of the subscription volume pricing.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            },
            "x-queryable":true
        },
        "VolumePricingEligibilityFlag":{
            "title":"Eligible for volume pricing",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the balance code is for enable eligibility rule of volume pricing.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Back to Top