Create subscription adjustments
/crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/products/{SubscriptionProductPuid}/child/coveredLevels/{CoveredLevelPuid}/child/charges/{ChargePuid}/child/adjustments
Request
-
ChargePuid(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=
-
CoveredLevelPuid(required): string
The covered level PUID
-
SubscriptionNumber(required): string
The alternate identifier of the subscription.
-
SubscriptionProductPuid(required): string
The subscription product PUID.
-
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.
- application/json
object
-
AdjustmentBasis: string
Title:
Basis
Maximum Length:30
The adjustment basis -
AdjustmentName: string
Title:
Adjustment
Maximum Length:120
The adjustment name -
AdjustmentReasonCode: string
Title:
Reason
Maximum Length:30
The code of the adjustment reason. -
AdjustmentReasonMeaning: string
Title:
Reason
The translated adjustment reason. -
AdjustmentType: string
Title:
Type
Maximum Length:30
The adjustment type -
AdjustmentValue: number
Title:
Value
The adjustment value -
AutoAdjustmentFlag: boolean
Maximum Length:
3
Flag indicating whether the adjustment is automatic or not -
ChargeAdjustmentId: integer
(int64)
The charge adjustment ID
-
ChargeAdjustmentPuid: string
Maximum Length:
120
The charge adjustment PUID -
ChargeId: integer
(int64)
The charge ID
-
Effectivity: string
Title:
Effectivity
Maximum Length:30
The adjustment effectivity -
NumberOfPeriods: number
The number of periods
-
ObjectVersionNumber: integer
(int32)
Object version number
-
PeriodFrom: number
The period from
-
PeriodUntil: number
The period until
-
Reason: string
Title:
Reason Description
Maximum Length:120
The adjustment reason -
SequenceNumber: integer
(int32)
Title:
Sequence
The sequence number -
SubscriptionId: integer
(int64)
The subscription ID
-
SubscriptionProductId: integer
(int64)
The subscription product ID
Response
- application/json
Default Response
-
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.
object
-
AdjustmentBasis: string
Title:
Basis
Maximum Length:30
The adjustment basis -
AdjustmentName: string
Title:
Adjustment
Maximum Length:120
The adjustment name -
AdjustmentReasonCode: string
Title:
Reason
Maximum Length:30
The code of the adjustment reason. -
AdjustmentReasonMeaning: string
Title:
Reason
The translated adjustment reason. -
AdjustmentType: string
Title:
Type
Maximum Length:30
The adjustment type -
AdjustmentValue: number
Title:
Value
The adjustment value -
AutoAdjustmentFlag: boolean
Maximum Length:
3
Flag indicating whether the adjustment is automatic or not -
ChargeAdjustmentId: integer
(int64)
The charge adjustment ID
-
ChargeAdjustmentPuid: string
Maximum Length:
120
The charge adjustment PUID -
ChargeId: integer
(int64)
The charge ID
-
CreatedBy: string
Read Only:
true
Maximum Length:64
The created by -
CreationDate: string
(date-time)
Read Only:
true
The creation date -
Effectivity: string
Title:
Effectivity
Maximum Length:30
The adjustment effectivity -
LastUpdateDate: string
(date-time)
Read Only:
true
The last update date -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The last updated by -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
The last update login -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
NumberOfPeriods: number
The number of periods
-
ObjectVersionNumber: integer
(int32)
Object version number
-
PeriodFrom: number
The period from
-
PeriodUntil: number
The period until
-
Reason: string
Title:
Reason Description
Maximum Length:120
The adjustment reason -
SequenceNumber: integer
(int32)
Title:
Sequence
The sequence number -
SubscriptionId: integer
(int64)
The subscription ID
-
SubscriptionProductId: integer
(int64)
The subscription product ID
array
Links
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.
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Examples
The following example shows how to create a subscription adjustment by submitting a POST request on the REST resource using cURL.
cURL Command
curl -u <username:password> \ -X POST https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/subscriptions/GP-5678/child/products/GP-5678-PRDT-1/child/coveredLevels/GP-7788-PRDT-13-PASS-5/child/charges/GP-5678-PRDT-1-CHRG-9/child/adjustments
Example of Request Body
The following example shows the contents of the request body in JSON format.
{ "ChargeAdjustmentPuid": "GP-7788-PRDT-13-CHRG-29-MADJ-3", "AdjustmentType": "ORA_DISCOUNT_PERCENT", "AdjustmentValue": 500, "AdjustmentBasis": "ORA_LIST_PRICE", "Reason": "Special seasonal offer", "SequenceNumber": 1, "AdjustmentName": "One-time Discount", "Effectivity": "ORA_ALL_TERM" }
Example of Response Body
The following example shows the contents of the response body in JSON format.
{ "ChargeAdjustmentId": 300100177241559, "ChargeAdjustmentPuid": "GP-7788-PRDT-13-CHRG-29-MADJ-3", "ChargeId": 300100177242683, "PeriodFrom": null, "PeriodUntil": null, "AdjustmentType": "ORA_DISCOUNT_PERCENT", "AdjustmentValue": 500, "AdjustmentBasis": "ORA_LIST_PRICE", "Reason": "Special seasonal offer", "SequenceNumber": 1, "SubscriptionId": 300100177232478, "SubscriptionProductId": 300100177232481, "AdjustmentName": "One-time Discount", "AutoAdjustmentFlag": null, "Effectivity": "ORA_ALL_TERM", "NumberOfPeriods": null, "ObjectVersionNumber": 1, "CreatedBy": "CONMGR", "CreationDate": "2019-06-05T08:12:00+00:00", "LastUpdateDate": "2019-06-05T08:12:00.428+00:00", "LastUpdateLogin": "8A5689AE12D939D9E05322EAF40A63A4", "LastUpdatedBy": "CONMGR", ... }