Get all subscription charges
get
/crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/products/{SubscriptionProductPuid}/child/charges
Request
Path Parameters
-
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 -
finder: string
Used as a predefined finder to search the collection.
Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
The following are the available finder names and corresponding finder variables:- ChargePuidAltKey: Finds the subscription charge with the specified Charge PUID
Finder Variables:- ChargePuid; string; The unique public identifier of the subscription charge.
- PrimaryKey: Finds the subscription charge with the specified charge ID.
Finder Variables:- ChargeId; integer; The unique primary identifier of the subscription charge.
- ChargePuidAltKey: Finds the subscription charge with the specified Charge PUID
-
limit: integer
This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
-
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 -
offset: integer
Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
-
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
-
orderBy: string
This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
-
q: string
This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
Format: ?q=expression1;expression2
You can use these queryable attributes to filter this collection resource using the q query parameter:- AggregationMethod; string; The aggregation method used for the charges.
- Allowance; number; The allowance
- AssetMeterYn; boolean; The flag whether it is an asset meter or not.
- BillLineId; integer; The bill line ID
- BillingFreq; string; Billing Frequency
- BillingFreqName; string; Billing Frequency Name
- BlockSize; number; The block size
- ChargeDefinition; string; The definition that indicates the purpose of the charge.
- ChargeDefinitionName; string; The charge definition name
- ChargeId; integer; The charge ID
- ChargeName; string; The charge name
- ChargePeriodCode; string; The code of the charge period associated with the charge.
- ChargePuid; string; The charge PUID
- CoveredLevelId; integer; The unique identifier of the covered level.
- CreatedBy; string; The created by
- CreationDate; string; The creation date
- EnableProration; string; Indicates whether proration is enabled or not.
- EstimatedAmount; number; The estimated amount of the charges.
- EstimatedQuantity; number; The estimated quantity for the charge.
- EstimationMethod; string; The method used to estimate the amount.
- ExternalKey; string; The external key
- ExternalParentKey; string; The external parent key
- InitialMeterReadingId; integer; The initial meter reading identifier value.
- InvoicingRuleId; integer; The ID of the invoice rule.
- LastUpdateDate; string; The last update date
- LastUpdateLogin; string; The last update login
- LastUpdatedBy; string; The last updated by
- MeterDefinitionId; integer; The unique identifier of the meter definition associated with the charges.
- MeterId; integer; The unique identifier of the meter associated with the charges.
- MilestoneBillingFlag; boolean; Indicates whether the billing is impacted by milestone events or not.
- MilestoneRevenueFlag; boolean; Indicates whether the revenue is impacted by milestone events or not.
- MilestoneTemplateId; integer; The ID of the milestone event associated with a charge.
- MinimumAmount; number; The minimum amount to be charged.
- MinimumQuantity; number; The minimum quantity that is allowed.
- PeriodicBillingFlag; boolean; Indicates whether periodic billing is allowed or not.
- PeriodicRevenueFlag; boolean; Indicates the periodic revenue recognition of one-time charges.
- PrePaymentNumber; integer; The prepayment number
- PricePeriodicity; string; The price periodicity
- PricePeriodicityName; string; The price periodicity name
- PriceType; string; The price type
- QuotedTcv; number; The quoted TCV of the charge.
- RecurringPricePeriodicityCode; string; The recurring price periodicity code of the charge.
- RollupFlag; boolean; Indicates if the charges are rolled up.
- SequenceNumber; integer; The sequence number
- SubscriptionId; integer; The subscription ID
- SubscriptionProductId; integer; The subscription product ID
- TierType; string; The tier type
- TieredFlag; boolean; The flag indicating whether the charge has tiers
- TrueUpPeriod; string; The identifier of the true up period.
- UnitListPrice; number; The unit list price
- UsagePriceLockFlag; boolean; Flag indicating whether the usage price is locked or not
- UsageUnitOfMeasure; string; The usage unit of measure of the charge.
-
totalResults: boolean
The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
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
Type:
Show Source
object
-
count(required): integer
The number of resource instances returned in the current range.
-
hasMore(required): boolean
Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
-
items: array
Items
Title:
Items
The items in the collection. -
limit(required): integer
The actual paging size used by the server.
-
links(required): array
Links
Title:
Links
The link relations associated with the resource instance. -
offset(required): integer
The offset value used in the current page.
-
totalResults: integer
The estimated row count when "?totalResults=true", otherwise the count is not included.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : subscriptions-products-charges-item-response
Type:
Show Source
object
-
adjustments: array
Adjustments
Title:
Adjustments
The adjustments resource is used to view, create, update, and delete any adjustments to the subscription charge. -
AggregationMethod: string
Maximum Length:
30
The aggregation method used for the charges. -
Allowance: number
Title:
Allowance
The allowance -
AssetMeterYn: boolean
Maximum Length:
1
The flag whether it is an asset meter or not. -
BillingFreq: string
Maximum Length:
30
Billing Frequency -
BillingFreqName: string
Title:
Billing Frequency
Maximum Length:255
Billing Frequency Name -
BillLineId: integer
(int64)
The bill line ID
-
BlockSize: number
Title:
Block Size
The block size -
ChargeDefinition: string
Title:
Charge Name
Maximum Length:30
The definition that indicates the purpose of the charge. -
ChargeDefinitionName: string
The charge definition name
-
ChargeId: integer
(int64)
The charge ID
-
chargeMilestoneEvents: array
Charge Milestone Events
Title:
Charge Milestone Events
The charge milestone events resource is used to view, create, update, and delete the milestone events associated with a charge of a subscription. -
ChargeName: string
Title:
Charge Name
Maximum Length:120
The charge name -
ChargePeriodCode: string
Maximum Length:
30
The code of the charge period associated with the charge. -
ChargePuid: string
Maximum Length:
120
The charge PUID -
chargeTiers: array
Charge Tiers
Title:
Charge Tiers
The charge tiers resource is used to view, create, update, and delete the subscription charge tier details for a subscription. -
CoveredLevelId: integer
(int64)
The unique identifier of the covered level.
-
CreatedBy: string
Read Only:
true
Maximum Length:64
The created by -
CreationDate: string
(date-time)
Read Only:
true
The creation date -
EnableProration: string
Maximum Length:
1
Indicates whether proration is enabled or not. -
EstimatedAmount: number
Title:
Estimated Amount
The estimated amount of the charges. -
EstimatedMethodName: string
Title:
Estimation Method
The method used to estimate the amount. -
EstimatedQuantity: number
Title:
Estimated Quantity
The estimated quantity for the charge. -
EstimationMethod: string
Title:
Estimation Method
Maximum Length:30
The method used to estimate the amount. -
ExternalKey: string
Maximum Length:
120
The external key -
ExternalParentKey: string
Maximum Length:
120
The external parent key -
InitialMeterReadingId: integer
(int64)
The initial meter reading identifier value.
-
InvoicingRuleId: integer
(int64)
The ID of the invoice rule.
-
InvoicingRuleName: string
Title:
Invoicing Rule
The name of the invoice rule. -
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. -
MeterDefinitionId: integer
(int64)
The unique identifier of the meter definition associated with the charges.
-
MeterId: integer
(int64)
The unique identifier of the meter associated with the charges.
-
MilestoneBillingFlag: boolean
Indicates whether the billing is impacted by milestone events or not.
-
MilestoneRevenueFlag: boolean
Indicates whether the revenue is impacted by milestone events or not.
-
MilestoneTemplateId: integer
(int64)
The ID of the milestone event associated with a charge.
-
MilestoneTemplateName: string
Maximum Length:
120
The name of the milestone template associated with a charge. -
MinimumAmount: number
Title:
Minimum Amount
The minimum amount to be charged. -
MinimumQuantity: number
Title:
Minimum Quantity
The minimum quantity that is allowed. -
PeriodicBillingFlag: boolean
Maximum Length:
1
Indicates whether periodic billing is allowed or not. -
PeriodicRevenueFlag: boolean
Title:
Enable Periodic Revenue Recognition
Maximum Length:1
Indicates the periodic revenue recognition of one-time charges. -
PrePaymentNumber: integer
(int64)
Title:
Prepayment Number
The prepayment number -
PricePeriodicity: string
Title:
Periodicity
Maximum Length:30
The price periodicity -
PricePeriodicityName: string
The price periodicity name
-
PriceType: string
Maximum Length:
30
The price type -
QuotedTcv: number
The quoted TCV of the charge.
-
RecurringPricePeriodicityCode: string
Maximum Length:
30
The recurring price periodicity code of the charge. -
RollupFlag: boolean
Maximum Length:
1
Indicates if the charges are rolled up. -
SequenceNumber: integer
(int32)
The sequence number
-
SubscriptionId: integer
(int64)
The subscription ID
-
SubscriptionProductId: integer
(int64)
The subscription product ID
-
TieredFlag: boolean
Maximum Length:
3
The flag indicating whether the charge has tiers -
TierType: string
Title:
Tier Type
Maximum Length:30
The tier type -
TrueUpPeriod: string
Title:
True Up Period
Maximum Length:30
Default Value:ORA_OSS_USAGE_BILLING_PERIOD
The identifier of the true up period. -
TrueUpPeriodName: string
Title:
True Up Period
The name of the true up period. -
UnitListPrice: number
Title:
List Price
The unit list price -
UsagePriceLockFlag: boolean
Maximum Length:
3
Flag indicating whether the usage price is locked or not -
UsageUnitOfMeasure: string
Maximum Length:
3
The usage unit of measure of the charge.
Nested Schema : Adjustments
Type:
array
Title:
Adjustments
The adjustments resource is used to view, create, update, and delete any adjustments to the subscription charge.
Show Source
Nested Schema : Charge Milestone Events
Type:
array
Title:
Charge Milestone Events
The charge milestone events resource is used to view, create, update, and delete the milestone events associated with a charge of a subscription.
Show Source
Nested Schema : Charge Tiers
Type:
array
Title:
Charge Tiers
The charge tiers resource is used to view, create, update, and delete the subscription charge tier details for a subscription.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : subscriptions-products-charges-adjustments-item-response
Type:
Show Source
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
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.
Nested Schema : subscriptions-products-charges-chargeMilestoneEvents-item-response
Type:
Show Source
object
-
BillingOffset: number
The billing offset associated with a milestone event.
-
BillLineId: integer
(int64)
The bill line ID associated with the milestone event.
-
ChargeId: integer
(int64)
The charge ID with which the milestone event is associated.
-
ChargePuid: string
Maximum Length:
120
Default Value:Charges.ChargePuid
The PUID of the charge to which the milestone event is associated. -
CompletionDate: string
(date)
The completion date of the milestone event.
-
CreatedBy: string
Read Only:
true
Maximum Length:64
The login which created the milestone event. -
CreationDate: string
(date-time)
Read Only:
true
The date on which the milestone event was created. -
EventId: integer
(int64)
The ID of the milestone event.
-
EventSource: string
Maximum Length:
30
The source of the milestone event. -
EventSourceReference: string
Maximum Length:
120
The source reference of the milestone event. -
EventType: string
Maximum Length:
30
The type of the milestone event. -
ExpectedCompletionDate: string
(date)
The expected completion date of a milestone event.
-
LastUpdateDate: string
(date-time)
Read Only:
true
The date of which the milestone event was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user who last updated the milestone event the last. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
The login which updated the milestone event the last. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MilestoneComment: string
Maximum Length:
300
The milestone event comment. -
MilestoneName: string
Maximum Length:
30
The name of the milestone event. -
MilestonePuid: string
Maximum Length:
120
The milestone event PUID. -
ObjectVersionNumber: integer
(int32)
The object version number of the milestone event.
-
Percentage: number
The percentage associated with a milestone event.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested 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
Examples
The following examples shows how to get all subscription charges by submitting a GET request on the REST resource using cURL.
cURL Command
curl -u <username:password> \ -X GET https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/subscriptions/GP5678/child/products/GP-5678-PRDT-1/child/charges
Response Body
The following shows the contents of the response body in JSON format.
{ "items": [ { "BillLineId": null, "ChargeDefinition": "ACTIVATIONFEE", "ChargeId": 300100177231506, "ChargePuid": "GP-5678-PRDT-1-CHRG-9", "CoveredLevelId": null, "PrePaymentNumber": null, "PricePeriodicity": null, "PriceType": "ONE_TIME", "RollupFlag": false, "SequenceNumber": 1, "SubscriptionId": 300100177254423, "SubscriptionProductId": 300100177254429, "ChargeName": "Activation Fee", "ExternalKey": null, "ExternalParentKey": null, "UnitListPrice": 3000, "Allowance": null, "BlockSize": null, "TieredFlag": null, "TierType": null, "UsagePriceLockFlag": null, "PricePeriodicityName": null, "ChargeDefinitionName": null, "CreatedBy": "CONMGR", "CreationDate": "2019-06-04T13:03:07.445+00:00", "LastUpdateDate": "2019-06-04T13:03:07.536+00:00", "LastUpdateLogin": "8A568A7FD0B9BE1EE05323EAF40A0287", "LastUpdatedBy": "CONMGR", ... }, { "BillLineId": null, "ChargeDefinition": "MONTHLYFEE", "ChargeId": 300100177231507, "ChargePuid": "GP-5678-PRDT-1-CHRG-10", "CoveredLevelId": null, "PrePaymentNumber": null, "PricePeriodicity": "0zG", "PriceType": "RECURRING", "RollupFlag": false, "SequenceNumber": 2, "SubscriptionId": 300100177254423, "SubscriptionProductId": 300100177254429, "ChargeName": "Monthly Fee", "ExternalKey": null, "ExternalParentKey": null, "UnitListPrice": 300, "Allowance": null, "BlockSize": null, "TieredFlag": null, "TierType": null, "UsagePriceLockFlag": null, "PricePeriodicityName": "MONTH", "ChargeDefinitionName": null, "CreatedBy": "CONMGR", "CreationDate": "2019-06-04T13:03:07.452+00:00", "LastUpdateDate": "2019-06-04T13:03:07.542+00:00", "LastUpdateLogin": "8A568A7FD0B9BE1EE05323EAF40A0287", "LastUpdatedBy": "CONMGR", ... }, ... }