Jump to

• Request
• Response

Update an entitlement plan charge rule

patch

/crmRestApi/resources/11.13.18.05/subscriptionEntitlementPlans/{EntitlementPlanNumber}/child/volumePricingRules/{EntitlementPlanChargeRuleNumber}

Request

Path Parameters

• EntitlementPlanChargeRuleNumber(required): string
  The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
• EntitlementPlanNumber(required): string
  The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=

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.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

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.
• 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.
• 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.
• VolumePricingAggregationFlag: boolean
  Title: Eligible for aggregation

  Maximum Length: 1

  Indicates whether the balance code is for enable aggregation rule of 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":{
        "AggregationPeriod":{
            "title":"Aggregation Period",
            "maxLength":30,
            "type":"string",
            "description":"The charge period of balance code for volume rating.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "BalanceCodeUnitOfMeasure":{
            "title":"UOM",
            "maxLength":3,
            "type":"string",
            "description":"The unit of measure of balance code for volume rating.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "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"
                ]
            }
        },
        "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
            }
        },
        "ChargeDefinitionCode":{
            "maxLength":30,
            "type":"string",
            "description":"The charge definition code of the entitlement plan detail charge definition.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "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"
            }
        },
        "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"
            }
        },
        "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
            }
        },
        "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"
            }
        },
        "BalanceProfileId":{
            "title":"Balance Profile ID",
            "type":"integer",
            "description":"The unique identifier of the subscription balance profile.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "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"
                ]
            }
        },
        "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
        },
        "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
        },
        "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"
                ]
            }
        },
        "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
            }
        },
        "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
            }
        },
        "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
            }
        },
        "EntitlementPlanChargeRuleNumber":{
            "title":"Charge Rule Number",
            "maxLength":120,
            "type":"string",
            "description":"The unique number of the subscription entitlement plan charge rule.",
            "nullable":true
        },
        "SubscriptionProductId":{
            "title":"Subscription Product ID",
            "type":"integer",
            "description":"The unique identifier of subscription product.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        }
    }
}

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-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.
• 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.
• VolumePricingAggregationFlag: boolean
  Title: Eligible for aggregation

  Maximum Length: 1

  Indicates whether the balance code is for enable aggregation rule of 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":{
        "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
        },
        "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
        },
        "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
        },
        "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
        },
        "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
        },
        "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
        },
        "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
        },
        "ChargeDefinitionCode":{
            "maxLength":30,
            "type":"string",
            "description":"The charge definition code of the entitlement plan detail charge definition.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "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
        },
        "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
        },
        "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
        },
        "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
        },
        "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
        },
        "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
        },
        "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
        },
        "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
        },
        "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
        },
        "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
        },
        "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
        },
        "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
        },
        "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
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "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
        },
        "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
        }
    }
}

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

Back to Top