Update an entitlement plan detail
patch
/crmRestApi/resources/11.13.18.05/subscriptionEntitlementPlans/{EntitlementPlanNumber}/child/subscriptionEntitlementPlanDetails/{EntitlementPlanDetailNumber}
Request
Path Parameters
-
EntitlementPlanDetailNumber(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:
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.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
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. -
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.
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.
Root Schema : subscriptionEntitlementPlans-subscriptionEntitlementPlanDetails-item-response
Type:
Show Source
object
-
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.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
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.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Links
- SubscriptionBalanceProfileBalanceCodeVA
-
The following properties are defined on the LOV link relation:
- Source Attribute: BalanceCode; Target Attribute: BalanceCode1
- Display Attribute: BalanceCode1