Create a charge tier
post
/crmRestApi/resources/11.13.18.05/subscriptionProducts/{SubscriptionProductPuid}/child/coveredLevels/{CoveredLevelPuid}/child/charges/{ChargePuid}/child/chargeTiers
Request
Path Parameters
-
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 public unique identifier of the covered level.
-
SubscriptionProductPuid(required): string
The public unique identifier of the subscription product.
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
Root Schema : schema
Type:
Show Source
object
-
AdditionalNumberFive: number
Title:
Additional Number Five
Additional number, if any, for the charge tier. -
AdditionalNumberFour: number
Title:
Additional Number Four
Additional number, if any, for the charge tier. -
AdditionalNumberOne: number
Title:
Additional Number One
Additional number, if any, for the charge tier. -
AdditionalNumberSix: number
Title:
Additional Number Six
Additional number, if any, for the charge tier. -
AdditionalNumberThree: number
Title:
Additional Number Three
Additional number, if any, for the charge tier. -
AdditionalNumberTwo: number
Title:
Additional Number Two
Additional number, if any, for the charge tier. -
AdditionalTextOne: string
Title:
Additional Text One
Maximum Length:4000
Additional text, if any, for the charge tier. -
AdditionalTextTwo: string
Title:
Additional Text Two
Maximum Length:4000
Additional text, if any, for the charge tier. -
AdditionalTimestampOne: string
(date-time)
Title:
Additional Time-stamp One
Additional timestamp, if any, for the charge tier. -
AdditionalTimestampThree: string
(date-time)
Title:
Additional Time-stamp Three
Additional timestamp, if any, for the charge tier. -
AdditionalTimestampTwo: string
(date-time)
Title:
Additional Time-stamp Two
Additional timestamp, if any, for the charge tier. -
AddtionalTextThree: string
Title:
Additional Text Three
Maximum Length:4000
Additional text, if any, for the charge tier. -
BlockSize: number
Title:
Block Size
The block size -
ChargeId: integer
(int64)
The unique identifier of the charge.
-
ChargeTierId: integer
(int64)
The unique identifier of the charge tier.
-
ChargeTierPuid: string
Maximum Length:
120
The public unique identifier of the charge tier. -
ListPrice: number
Title:
List Price
The list price -
PriceFormat: string
Title:
Price Format
Maximum Length:30
The display format of the price. -
SequenceNumber: number
The sequence number
-
SubscriptionId: integer
(int64)
The unique identifier of the subscription.
-
SubscriptionProductId: integer
(int64)
The unique identifier of the subscription product.
-
TierFrom: number
Title:
Tier From
The tier from -
TierTo: number
Title:
Tier To
The tier to
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 : subscriptionProducts-coveredLevels-charges-chargeTiers-item-response
Type:
Show Source
object
-
AdditionalNumberFive: number
Title:
Additional Number Five
Additional number, if any, for the charge tier. -
AdditionalNumberFour: number
Title:
Additional Number Four
Additional number, if any, for the charge tier. -
AdditionalNumberOne: number
Title:
Additional Number One
Additional number, if any, for the charge tier. -
AdditionalNumberSix: number
Title:
Additional Number Six
Additional number, if any, for the charge tier. -
AdditionalNumberThree: number
Title:
Additional Number Three
Additional number, if any, for the charge tier. -
AdditionalNumberTwo: number
Title:
Additional Number Two
Additional number, if any, for the charge tier. -
AdditionalTextOne: string
Title:
Additional Text One
Maximum Length:4000
Additional text, if any, for the charge tier. -
AdditionalTextTwo: string
Title:
Additional Text Two
Maximum Length:4000
Additional text, if any, for the charge tier. -
AdditionalTimestampOne: string
(date-time)
Title:
Additional Time-stamp One
Additional timestamp, if any, for the charge tier. -
AdditionalTimestampThree: string
(date-time)
Title:
Additional Time-stamp Three
Additional timestamp, if any, for the charge tier. -
AdditionalTimestampTwo: string
(date-time)
Title:
Additional Time-stamp Two
Additional timestamp, if any, for the charge tier. -
AddtionalTextThree: string
Title:
Additional Text Three
Maximum Length:4000
Additional text, if any, for the charge tier. -
BlockSize: number
Title:
Block Size
The block size -
ChargeId: integer
(int64)
The unique identifier of the charge.
-
ChargeTierId: integer
(int64)
The unique identifier of the charge tier.
-
ChargeTierPuid: string
Maximum Length:
120
The public unique identifier of the charge tier. -
CreatedBy: string
Read Only:
true
Maximum Length:64
The user who created the charge tier. -
CreationDate: string
(date-time)
Read Only:
true
The date when the charge tier was created. -
LastUpdateDate: string
(date-time)
Read Only:
true
The date when the charge tier was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user who last updated the charge tier. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
The login details of the user who last updated the charge tier. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ListPrice: number
Title:
List Price
The list price -
PriceFormat: string
Title:
Price Format
Maximum Length:30
The display format of the price. -
SequenceNumber: number
The sequence number
-
SubscriptionId: integer
(int64)
The unique identifier of the subscription.
-
SubscriptionProductId: integer
(int64)
The unique identifier of the subscription product.
-
TierFrom: number
Title:
Tier From
The tier from -
TierTo: number
Title:
Tier To
The tier to
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.