Get a subscription charge tier
get
/crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/products/{SubscriptionProductPuid}/child/charges/{ChargePuid}/child/chargeTiers/{ChargeTierPuid}
Request
Path Parameters
-
ChargePuid(required): string
The charge PUID
-
ChargeTierPuid(required): string
The charge tier PUID
-
SubscriptionNumber(required): string
The alternate identifier of the subscription.
-
SubscriptionProductPuid(required): string
The subscription product PUID.
Query Parameters
-
dependency: string
This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
Format: <attr1>=<val1>,<attr2>=<value2> -
expand: string
When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
-
fields: string
This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
Format: ?fields=Attribute1,Attribute2
Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2 -
links: string
This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
Example:
self,canonical -
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
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.
There's no request body for this operation.
Back to TopResponse
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 : subscriptions-products-charges-chargeTiers-item-response
Type:
Show Source
object
-
AdditionalNumberFive: number
Title:
Additional Number Five
The additional number five -
AdditionalNumberFour: number
Title:
Additional Number Four
The additional number four -
AdditionalNumberOne: number
Title:
Additional Number One
The additional number one -
AdditionalNumberSix: number
Title:
Additional Number Six
The additional number six -
AdditionalNumberThree: number
Title:
Additional Number Three
The additional number three -
AdditionalNumberTwo: number
Title:
Additional Number Two
The additional number two -
AdditionalTextOne: string
Title:
Additional Text One
Maximum Length:4000
The additional text one -
AdditionalTextTwo: string
Title:
Additional Text Two
Maximum Length:4000
The additional text two -
AdditionalTimestampOne: string
(date-time)
Title:
Additional Time-stamp One
The additional timestamp one -
AdditionalTimestampThree: string
(date-time)
Title:
Additional Time-stamp Three
The additional timestamp three -
AdditionalTimestampTwo: string
(date-time)
Title:
Additional Time-stamp Two
The additional timestamp two -
AddtionalTextThree: string
Title:
Additional Text Three
Maximum Length:4000
The additional text three -
BlockSize: number
Title:
Block Size
The block size -
ChargeId: integer
(int64)
The charge ID
-
ChargeTierId: integer
(int64)
The charge tier ID
-
ChargeTierPuid: string
Maximum Length:
120
The charge tier PUID -
CreatedBy: string
Read Only:
true
Maximum Length:64
The created by -
CreationDate: string
(date-time)
Read Only:
true
The creation date -
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. -
ListPrice: number
Title:
List Price
The list price -
PriceFormat: string
Title:
Price Format
Maximum Length:30
The price format -
SequenceNumber: number
The sequence number
-
SubscriptionId: integer
(int64)
The subscription ID
-
SubscriptionProductId: integer
(int64)
The subscription product ID
-
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.