Jump to

• Request
• Response

Create an entitlement plan

post

/crmRestApi/resources/11.13.18.05/subscriptionEntitlementPlans

Request

Header Parameters

• 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.
• Upsert-Mode:
  Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• BalanceProfileId(required): integer (int64)
  The balance profile identifier of the subscription entitlement plan.
• BalanceProfileName: string
  Title: Name

  Maximum Length: 120

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

  Maximum Length: 120

  The balance profile number of the subscription entitlement plan.
• 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.
• EntitlementPlanDescription: string
  Title: Description

  Maximum Length: 300

  The description of the subscription entitlement plan.
• EntitlementPlanId: integer (int64)
  The unique identifier of the subscription entitlement plan.
• EntitlementPlanName(required): string
  Title: Name

  Maximum Length: 120

  The unique name of the subscription entitlement plan.
• EntitlementPlanNumber(required): string
  Title: Number

  Maximum Length: 120

  The unique number of the subscription entitlement plan.
• EntitlementPlanStatus: string
  Title: Status

  Maximum Length: 30

  Default Value: ORA_OSS_DRAFT

  The status of the subscription entitlement plan.
• 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.
• EventType: string
  Title: Event Type

  Maximum Length: 30

  The type of the event.
• EventTypeId: integer (int64)
  The unique identifier of the event of an event type.
• ObjectVersionNumber: integer (int32)
  The version number of subscription entitlement plan.
• subscriptionEntitlementPlanDetails: 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.

{
    "required":[
        "BalanceProfileId",
        "EntitlementPlanName",
        "EntitlementPlanNumber"
    ],
    "type":"object",
    "properties":{
        "BalanceProfileNumber":{
            "title":"Number",
            "maxLength":"120",
            "type":"string",
            "description":"The balance profile number of the subscription entitlement plan.",
            "nullable":false,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "EntitlementPlanDescription":{
            "title":"Description",
            "maxLength":"300",
            "type":"string",
            "description":"The description of the subscription entitlement plan.",
            "nullable":true
        },
        "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/subscriptionEntitlementPlans-commitments-item-post-request"
            }
        },
        "EventType":{
            "title":"Event Type",
            "maxLength":"30",
            "type":"string",
            "description":"The type of the event.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "EventTypeId":{
            "type":"integer",
            "description":"The unique identifier of the event of an event type.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "BalanceProfileName":{
            "title":"Name",
            "maxLength":"120",
            "type":"string",
            "description":"The balance profile name of the subscription entitlement plan.",
            "nullable":false,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "EntitlementPlanId":{
            "type":"integer",
            "description":"The unique identifier of the subscription entitlement plan.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "BalanceProfileId":{
            "type":"integer",
            "description":"The balance profile identifier of the subscription entitlement plan.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "EntitlementPlanStatus":{
            "title":"Status",
            "maxLength":"30",
            "type":"string",
            "description":"The status of the subscription entitlement plan.",
            "nullable":false,
            "default":"ORA_OSS_DRAFT",
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"The version number of subscription entitlement plan.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":"9"
            }
        },
        "EntitlementPlanNumber":{
            "title":"Number",
            "maxLength":"120",
            "type":"string",
            "description":"The unique number of the subscription entitlement plan.",
            "nullable":false
        },
        "EntitlementPlanName":{
            "title":"Name",
            "maxLength":"120",
            "type":"string",
            "description":"The unique name of the subscription entitlement plan.",
            "nullable":false
        },
        "subscriptionEntitlementPlanDetails":{
            "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/subscriptionEntitlementPlans-subscriptionEntitlementPlanDetails-item-post-request"
            }
        },
        "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/subscriptionEntitlementPlans-estimates-item-post-request"
            }
        }
    }
}

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 subscriptionEntitlementPlans-commitments-item-post-request

{
    "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/subscriptionEntitlementPlans-commitments-item-post-request"
    }
}

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 subscriptionEntitlementPlans-estimates-item-post-request

{
    "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/subscriptionEntitlementPlans-estimates-item-post-request"
    }
}

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 subscriptionEntitlementPlans-subscriptionEntitlementPlanDetails-item-post-request

{
    "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/subscriptionEntitlementPlans-subscriptionEntitlementPlanDetails-item-post-request"
    }
}

Nested Schema : subscriptionEntitlementPlans-commitments-item-post-request

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)
  The unique identifier of balance code of the subscription entitlement plan commitments.
• 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.
• 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.
• 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.
• 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.
• UnitOfMeasure: string
  Title: UOM

  Maximum Length: 3

  The unit of measure of the subscription entitlement plan commitments.

{
    "type":"object",
    "properties":{
        "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
            }
        },
        "EntitlementPlanCommitmentId":{
            "type":"integer",
            "description":"The unique identifier of entitlement plan commitments.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "UnitOfMeasure":{
            "title":"UOM",
            "maxLength":"3",
            "type":"string",
            "description":"The unit of measure of the subscription entitlement plan commitments.",
            "nullable":true
        },
        "Amount":{
            "title":"Amount",
            "type":"number",
            "description":"The amount of the subscription entitlement plan commitments.",
            "nullable":true
        },
        "Period":{
            "title":"Periodicity",
            "type":"string",
            "description":"The period of the subscription entitlement plan commitments.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "Quantity":{
            "title":"Quantity",
            "type":"number",
            "description":"The quantity of the subscription entitlement plan commitments.",
            "nullable":true
        },
        "ChargeDefinitionCode":{
            "maxLength":"30",
            "type":"string",
            "description":"The charge definition code of the subscription entitlement plan commitments.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "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"
            }
        },
        "RoundedQuantity":{
            "title":"Rounded Quantity",
            "type":"number",
            "description":"The rounded quantity of the subscription entitlement plan commitments.",
            "nullable":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"
            }
        },
        "CurrencyCode":{
            "title":"Currency Code",
            "maxLength":"15",
            "type":"string",
            "description":"The currency code of the subscription entitlement plan commitments.",
            "nullable":true
        },
        "BalanceCodeId":{
            "type":"integer",
            "description":"The unique identifier of balance code of the subscription entitlement plan commitments.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "ChargeDefinitionId":{
            "type":"integer",
            "description":"The unique identifier of charge definition of the subscription entitlement plan commitments.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "RelatedChargeDefinitionId":{
            "type":"integer",
            "description":"The unique identifier of charge definition of the related charge.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "RelatedChargeDefinitionCode":{
            "maxLength":"30",
            "type":"string",
            "description":"The charge definition code of the related charge identifier.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "EntitlementPlanCommitmentNumber":{
            "maxLength":"120",
            "type":"string",
            "description":"The unique number of entitlement plan commitments.",
            "nullable":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"
            }
        }
    }
}

Nested Schema : subscriptionEntitlementPlans-estimates-item-post-request

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)
  The unique identifier of balance code of the subscription entitlement plan estimates.
• 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.
• 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.
• 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
  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.
• 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.
• 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":{
        "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
        },
        "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
        },
        "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
        },
        "UnitOfMeasure":{
            "title":"UOM",
            "maxLength":"3",
            "type":"string",
            "description":"The unit of measure of the subscription entitlement plan estimates.",
            "nullable":true
        },
        "Amount":{
            "title":"Amount",
            "type":"number",
            "description":"The amount of the subscription entitlement plan estimates.",
            "nullable":true
        },
        "Period":{
            "title":"Periodicity",
            "type":"string",
            "description":"The period of the subscription entitlement plan estimates.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "Quantity":{
            "title":"Quantity",
            "type":"number",
            "description":"The quantity of the subscription entitlement plan estimates.",
            "nullable":true
        },
        "ChargeDefinitionCode":{
            "maxLength":"30",
            "type":"string",
            "description":"The charge definition code of the subscription entitlement plan estimates.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "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"
            }
        },
        "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"
            }
        },
        "EntitlementPlanEstimateNumber":{
            "maxLength":"120",
            "type":"string",
            "description":"The unique number of entitlement plan estimates.",
            "nullable":false
        },
        "RoundedQuantity":{
            "title":"Rounded Quantity",
            "type":"number",
            "description":"The rounded quantity of the subscription entitlement plan estimates.",
            "nullable":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"
            }
        },
        "CurrencyCode":{
            "title":"Currency Code",
            "maxLength":"15",
            "type":"string",
            "description":"The currency code of the subscription entitlement plan estimates.",
            "nullable":true
        },
        "BalanceCodeId":{
            "type":"integer",
            "description":"The unique identifier of balance code of the subscription entitlement plan estimates.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "ChargeDefinitionId":{
            "type":"integer",
            "description":"The unique identifier of charge definition of the subscription entitlement plan estimates.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "RelatedChargeDefinitionId":{
            "type":"integer",
            "description":"The unique identifier of charge definition of the related charge.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "RelatedChargeDefinitionCode":{
            "maxLength":"30",
            "type":"string",
            "description":"The charge definition code of the related charge identifier.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "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
        },
        "SubscriptionProductId":{
            "type":"integer",
            "description":"The unique identifier of subscription product of the subscription entitlement plan estimates.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "EntitlementPlanEstimateId":{
            "type":"integer",
            "description":"The unique identifier of the subscription entitlement plan estimates.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "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
            }
        }
    }
}

Nested Schema : subscriptionEntitlementPlans-subscriptionEntitlementPlanDetails-item-post-request

Type: object

Show Source

• AllowancePeriodicity: string
  Title: Periodicity

  Maximum Length: 30

  The periodicity factor of allowance under subscription entitlement plan details.
• 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.
• BalanceCode: string
  Title: Balance Code

  Maximum Length: 30

  The balance code of subscription entitlement plan details.
• BalanceCodeId: integer (int64)
  The unique identifier of balance code under subscription entitlement plan details.
• 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.
• 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.
• ObjectVersionNumber: integer (int32)
  The version number of subscription entitlement plan details.
• SubscriptionProductId: integer (int64)
  The subscription product identifier of subscription entitlement plan details.

{
    "type":"object",
    "properties":{
        "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"
            }
        },
        "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"
            }
        },
        "Amount":{
            "title":"Amount",
            "type":"number",
            "description":"The amount under subscription entitlement plan details.",
            "nullable":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"
            }
        },
        "ChargeDefinitionCode":{
            "maxLength":"30",
            "type":"string",
            "description":"The charge definition code under subscription entitlement plan details.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "EntitlementPlanDetailNumber":{
            "maxLength":"120",
            "type":"string",
            "description":"The unique number of subscription entitlement plan details.",
            "nullable":false
        },
        "BalanceCode":{
            "title":"Balance Code",
            "maxLength":"30",
            "type":"string",
            "description":"The balance code of subscription entitlement plan details.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "AllowanceQuantity":{
            "title":"Quantity",
            "type":"number",
            "description":"The allowance quantity under subscription entitlement plan details.",
            "nullable":true
        },
        "EntitlementPlanId":{
            "type":"integer",
            "description":"The unique identifier of subscription entitlement plan.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "CurrencyCode":{
            "title":"Currency",
            "maxLength":"15",
            "type":"string",
            "description":"The currency code of amount type balance code under subscription entitlement plan details.",
            "nullable":true
        },
        "BalanceCodeId":{
            "type":"integer",
            "description":"The unique identifier of balance code under subscription entitlement plan details.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "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"
            }
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"The version number of subscription entitlement plan details.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":"9"
            }
        },
        "ChargeDefinitionId":{
            "type":"integer",
            "description":"The unique identifier for charge definition under subscription entitlement plan details.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "EntitlementPlanDetailId":{
            "type":"integer",
            "description":"The unique identifier of subscription entitlement plan details.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "AllowanceValidityPeriod":{
            "title":"Validity Period",
            "type":"integer",
            "description":"The allowance validity period under subscription entitlement plan details.",
            "nullable":true
        },
        "SubscriptionProductId":{
            "type":"integer",
            "description":"The subscription product identifier of subscription entitlement plan details.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "AllowanceRolloverPeriod":{
            "title":"Rollover Period",
            "type":"integer",
            "description":"The allowance rollover period under subscription entitlement plan details.",
            "nullable":true
        }
    }
}

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 : subscriptionEntitlementPlans-item-response

Type: object

Show Source

• BalanceProfileId: integer (int64)
  The balance profile identifier of the subscription entitlement plan.
• BalanceProfileName: string
  Title: Name

  Maximum Length: 120

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

  Maximum Length: 120

  The balance profile number of the subscription entitlement plan.
• 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 entitlement plan.
• CreationDate: string (date-time)
  Read Only: true

  The date of creation of the subscription entitlement plan.
• EntitlementPlanDescription: string
  Title: Description

  Maximum Length: 300

  The description of the subscription entitlement plan.
• EntitlementPlanId: integer (int64)
  The unique identifier of the subscription entitlement plan.
• EntitlementPlanName: string
  Title: Name

  Maximum Length: 120

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

  Maximum Length: 120

  The unique number of the subscription entitlement plan.
• EntitlementPlanStatus: string
  Title: Status

  Maximum Length: 30

  Default Value: ORA_OSS_DRAFT

  The status of the subscription entitlement plan.
• 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.
• EventType: string
  Title: Event Type

  Maximum Length: 30

  The type of the event.
• EventTypeId: integer (int64)
  The unique identifier of the event of an event type.
• LastUpdateDate: string (date-time)
  Read Only: true

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

  Maximum Length: 64

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

  Maximum Length: 32

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

  The link relations associated with the resource instance.
• ObjectVersionNumber: integer (int32)
  The version number of subscription entitlement plan.
• subscriptionEntitlementPlanDetails: 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.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who has last updated the subscription entitlement plan.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "BalanceProfileNumber":{
            "title":"Number",
            "maxLength":"120",
            "type":"string",
            "description":"The balance profile number of the subscription entitlement plan.",
            "nullable":false,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "EntitlementPlanDescription":{
            "title":"Description",
            "maxLength":"300",
            "type":"string",
            "description":"The description of the subscription entitlement plan.",
            "nullable":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date of creation of the subscription entitlement plan.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "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/subscriptionEntitlementPlans-commitments-item-response"
            }
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the subscription entitlement plan.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "EventType":{
            "title":"Event Type",
            "maxLength":"30",
            "type":"string",
            "description":"The type of the event.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "EventTypeId":{
            "type":"integer",
            "description":"The unique identifier of the event of an event type.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "BalanceProfileName":{
            "title":"Name",
            "maxLength":"120",
            "type":"string",
            "description":"The balance profile name of the subscription entitlement plan.",
            "nullable":false,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "EntitlementPlanId":{
            "type":"integer",
            "description":"The unique identifier of the subscription entitlement plan.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "BalanceProfileId":{
            "type":"integer",
            "description":"The balance profile identifier of the subscription entitlement plan.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "EntitlementPlanStatus":{
            "title":"Status",
            "maxLength":"30",
            "type":"string",
            "description":"The status of the subscription entitlement plan.",
            "nullable":false,
            "default":"ORA_OSS_DRAFT",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"The version number of subscription entitlement plan.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":"9"
            },
            "x-queryable":true
        },
        "EntitlementPlanNumber":{
            "title":"Number",
            "maxLength":"120",
            "type":"string",
            "description":"The unique number of the subscription entitlement plan.",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "EntitlementPlanName":{
            "title":"Name",
            "maxLength":"120",
            "type":"string",
            "description":"The unique name of the subscription entitlement plan.",
            "nullable":false,
            "x-queryable":true
        },
        "subscriptionEntitlementPlanDetails":{
            "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/subscriptionEntitlementPlans-subscriptionEntitlementPlanDetails-item-response"
            }
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date when the subscription entitlement plan 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.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "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/subscriptionEntitlementPlans-estimates-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 subscriptionEntitlementPlans-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/subscriptionEntitlementPlans-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 subscriptionEntitlementPlans-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/subscriptionEntitlementPlans-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 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 subscriptionEntitlementPlans-subscriptionEntitlementPlanDetails-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/subscriptionEntitlementPlans-subscriptionEntitlementPlanDetails-item-response"
    }
}

Nested Schema : subscriptionEntitlementPlans-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)
  The unique identifier of balance code of the subscription entitlement plan commitments.
• 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.
• 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.
• 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.
• 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.
• UnitOfMeasure: string
  Title: UOM

  Maximum Length: 3

  The unit of measure of the subscription entitlement plan commitments.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated 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
        },
        "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
            }
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the subscription entitlement plan commitments.",
            "nullable":false,
            "readOnly":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
        },
        "UnitOfMeasure":{
            "title":"UOM",
            "maxLength":"3",
            "type":"string",
            "description":"The unit of measure of the subscription entitlement plan commitments.",
            "nullable":true,
            "x-queryable":true
        },
        "Amount":{
            "title":"Amount",
            "type":"number",
            "description":"The amount of the subscription entitlement plan commitments.",
            "nullable":true,
            "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
        },
        "ChargeDefinitionCode":{
            "maxLength":"30",
            "type":"string",
            "description":"The charge definition code of the subscription entitlement plan commitments.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "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
        },
        "RoundedQuantity":{
            "title":"Rounded Quantity",
            "type":"number",
            "description":"The rounded quantity of the subscription 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
        },
        "CurrencyCode":{
            "title":"Currency Code",
            "maxLength":"15",
            "type":"string",
            "description":"The currency code of the subscription entitlement plan commitments.",
            "nullable":true,
            "x-queryable":true
        },
        "BalanceCodeId":{
            "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
        },
        "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
        },
        "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
        },
        "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
        },
        "RelatedChargeDefinitionCode":{
            "maxLength":"30",
            "type":"string",
            "description":"The charge definition code of the related charge identifier.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "EntitlementPlanCommitmentNumber":{
            "maxLength":"120",
            "type":"string",
            "description":"The unique number of 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
        },
        "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
        }
    }
}

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 : subscriptionEntitlementPlans-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)
  The unique identifier of balance code of the subscription entitlement plan estimates.
• 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.
• 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.
• 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
  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.
• 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.
• 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":{
        "CreationDate":{
            "type":"string",
            "description":"The date when the subscription entitlement plan estimates was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":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
        },
        "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
        },
        "ChargeDefinitionCode":{
            "maxLength":"30",
            "type":"string",
            "description":"The charge definition code of the subscription entitlement plan estimates.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "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
        },
        "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
        },
        "RoundedQuantity":{
            "title":"Rounded Quantity",
            "type":"number",
            "description":"The rounded quantity of the subscription entitlement plan estimates.",
            "nullable":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
        },
        "BalanceCodeId":{
            "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
        },
        "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
        },
        "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
        },
        "RelatedChargeDefinitionCode":{
            "maxLength":"30",
            "type":"string",
            "description":"The charge definition code of the related charge identifier.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "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
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "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
        },
        "EntitlementPlanEstimateId":{
            "type":"integer",
            "description":"The unique identifier of the subscription entitlement plan estimates.",
            "format":"int64",
            "nullable":false,
            "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
            }
        },
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who has last updated the subscription entitlement plan estimates.",
            "nullable":false,
            "readOnly":true,
            "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
        },
        "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
        },
        "UnitOfMeasure":{
            "title":"UOM",
            "maxLength":"3",
            "type":"string",
            "description":"The unit of measure of the subscription entitlement plan estimates.",
            "nullable":true,
            "x-queryable":true
        },
        "Amount":{
            "title":"Amount",
            "type":"number",
            "description":"The amount of the subscription entitlement plan estimates.",
            "nullable":true,
            "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
        },
        "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
        },
        "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
        },
        "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
        }
    }
}

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 : subscriptionEntitlementPlans-subscriptionEntitlementPlanDetails-item-response

Type: object

Show Source

• AllowancePeriodicity: string
  Title: Periodicity

  Maximum Length: 30

  The periodicity factor of allowance under subscription entitlement plan details.
• 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.
• 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)
  The unique identifier of balance code under subscription entitlement plan details.
• 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.
• 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.
• 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.
• 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.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "type":"string",
            "description":"The date of creation of the subscription entitlement plan details.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "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"
            }
        },
        "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
        },
        "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
        },
        "PrecisionType":{
            "title":"Rounding Type",
            "maxLength":"30",
            "type":"string",
            "description":"The precision type of subscription entitlement plan details.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "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
        },
        "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
        },
        "PrecisionFactor":{
            "title":"Rounding Factor",
            "type":"number",
            "description":"The precision factor of subscription entitlement plan details.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BalanceCodeId":{
            "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
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"The version number of subscription entitlement plan details.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":"9"
            },
            "x-queryable":true
        },
        "AllowanceValidityPeriod":{
            "title":"Validity Period",
            "type":"integer",
            "description":"The allowance validity period under subscription entitlement plan details.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "SubscriptionProductId":{
            "type":"integer",
            "description":"The subscription product identifier of subscription entitlement plan details.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "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
        },
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who has last updated the subscription entitlement plan details.",
            "nullable":false,
            "readOnly":true,
            "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
        },
        "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
        },
        "Amount":{
            "title":"Amount",
            "type":"number",
            "description":"The amount under subscription entitlement plan details.",
            "nullable":true,
            "x-queryable":true
        },
        "EntitlementPlanDetailNumber":{
            "maxLength":"120",
            "type":"string",
            "description":"The unique number of subscription entitlement plan details.",
            "nullable":false,
            "x-queryable":true
        },
        "AllowanceQuantity":{
            "title":"Quantity",
            "type":"number",
            "description":"The allowance quantity under subscription entitlement plan details.",
            "nullable":true,
            "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
        },
        "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
        },
        "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
        },
        "EntitlementPlanDetailId":{
            "type":"integer",
            "description":"The unique identifier of subscription entitlement plan details.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "AllowanceRolloverPeriod":{
            "title":"Rollover Period",
            "type":"integer",
            "description":"The allowance rollover period under subscription entitlement plan details.",
            "nullable":true,
            "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
        }
    }
}

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"
    }
}

Links

EntitlementPlanStatusVA

Operation: /crmRestApi/resources/11.13.18.05/fndStaticLookups

Parameters:

• finder: LookupTypeIsActiveEnabledFinder%3BBindLookupType%3DORA_OSS_BALANCE_MGMT_SETUP_STS

The following properties are defined on the LOV link relation:

• Source Attribute: EntitlementPlanStatus; Target Attribute: LookupCode
• Display Attribute: Meaning

activate

Operation: /crmRestApi/resources/11.13.18.05/subscriptionEntitlementPlans/{EntitlementPlanNumber}/action/activate

Parameters:

• EntitlementPlanNumber: $request.path.EntitlementPlanNumber

The method is used to activate an entitlement plan.

commitments

Operation: /crmRestApi/resources/11.13.18.05/subscriptionEntitlementPlans/{EntitlementPlanNumber}/child/commitments

Parameters:

• EntitlementPlanNumber: $request.path.EntitlementPlanNumber

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.

deActivate

Operation: /crmRestApi/resources/11.13.18.05/subscriptionEntitlementPlans/{EntitlementPlanNumber}/action/deActivate

Parameters:

• EntitlementPlanNumber: $request.path.EntitlementPlanNumber

The method is used to deactivate an entitlement plan.

estimates

Operation: /crmRestApi/resources/11.13.18.05/subscriptionEntitlementPlans/{EntitlementPlanNumber}/child/estimates

Parameters:

• EntitlementPlanNumber: $request.path.EntitlementPlanNumber

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.

subscriptionEntitlementPlanDetails

Operation: /crmRestApi/resources/11.13.18.05/subscriptionEntitlementPlans/{EntitlementPlanNumber}/child/subscriptionEntitlementPlanDetails

Parameters:

• EntitlementPlanNumber: $request.path.EntitlementPlanNumber

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

Back to Top