1. REST API for Sales and Fusion Service in Oracle Fusion Cloud Customer Experience
  2. Tasks
  3. Subscription Products
  4. Charges

Get all charges

get

/crmRestApi/resources/11.13.18.05/subscriptionProducts/{SubscriptionProductPuid}/child/charges

Request

Path Parameters
Query Parameters
  • 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>
  • 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).
  • 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
  • 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 a subscription charge with the specified Charge PUID.
      Finder Variables:
      • ChargePuid; string; The public unique identifier of the charge.
    • PrimaryKey: Finds a subscription charge with the specified Charge ID.
      Finder Variables:
      • ChargeId; integer; The unique identifier of the charge.
  • 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.
  • 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
  • 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.
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
  • 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
  • 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 part of the charge.
    • AssetMeterYn; boolean; The flag whether it is an asset meter or not.
    • BatchTag; string; Batch Tag
    • BillLineId; integer; The unique identifier of the bill line.
    • BillingFreq; string; Billing Frequency
    • BillingFreqName; string; Billing Frequency Name
    • BlockSize; number; The block size of the charge.
    • ChargeDefinition; string; The definition that indicates the purpose of the charge.
    • ChargeDefinitionName; string; The name of the charge definition.
    • ChargeId; integer; The unique identifier of the charge.
    • ChargeName; string; The name of the charge.
    • ChargePeriodCode; string; The code of the charge period associated with the charge.
    • ChargePuid; string; The public unique identifier of the charge.
    • ChargeTypeRest; string; Charge Type
    • CoveredLevelId; integer; The unique identifier of the covered level.
    • CreatedBy; string; The user who created the charge.
    • CreationDate; string; The date when the charge was created.
    • 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 used to measure the charge.
    • 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 date when the charge was last updated.
    • LastUpdateLogin; string; The login details of the user who last updated the charge.
    • LastUpdatedBy; string; The user who last updated the charge.
    • 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 for the charge.
    • PricePeriodicity; string; The price periodicity for the charge. Indicates the frequency when the charge has to be applied.
    • PricePeriodicityName; string; The name of the price periodicity.
    • PriceType; string; The price type associated with the charge.
    • PricedQuantityRest; number; Priced Quantity
    • PricedQuantityUomRest; string; Priced Quantity UOM
    • QuotedTcv; number; The quoted TCV of the charge.
    • RecurringPricePeriodicityCode; string; The recurring price periodicity code of the charge.
    • RollupFlag; boolean; Indicates if the charge needs to be rolled up.
    • SequenceNumber; integer; The sequence number for the charge.
    • SubscriptionId; integer; The unique identifier of the subscription.
    • SubscriptionProductId; integer; The unique identifier of the subscription product.
    • TierType; string; The type of the charge tier.
    • TieredFlag; boolean; Indicates whether the charge has tiers.
    • TrueUpPeriod; string; The identifier of the trueup period.
    • UnitListPrice; number; The price of the unit list.
    • UsagePriceLockFlag; boolean; Indicates whether the usage price is locked or not.
    • UsageUnitOfMeasure; string; The usage unit of measure of the charge.
  • 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
  • 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".
  • 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 Top

Response

Supported Media Types

Default Response

The following table describes the default response for this task.
Headers
  • 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".
  • 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.
Body ()
Root Schema : subscriptionProducts-charges
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : subscriptionProducts-charges-item-response
Type: object
Show Source
Nested Schema : Adjustments
Type: array
Title: Adjustments
The adjustments resource is used to view, create, update, and delete the subscription charge adjustment details, such as adjustment name, adjustment type, adjustment value, adjustment reason, and effectivity.
Show Source
Nested Schema : Subcription Product Charge Components Records
Type: array
Title: Subcription Product Charge Components Records
The subscription product charge components records resoure is used to view the price details of the individual charge components of subscription products.
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, such as tier from, tier to, and list price.
Show Source
Nested Schema : subscriptionProducts-charges-adjustments-item-response
Type: object
Show Source
Nested Schema : subscriptionProducts-charges-chargeComponents-item-response
Type: object
Show Source
Nested Schema : subscriptionProducts-charges-chargeMilestoneEvents-item-response
Type: object
Show Source
Nested Schema : subscriptionProducts-charges-chargeTiers-item-response
Type: object
Show Source
Back to Top

Examples

The following example shows how to get all 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/subscriptionProducts/300100182015426/child/charges

Example of Response Body

The following example shows the contents of the response body in JSON format.

{
  "items": [
    {
      "BillLineId": null,
      "ChargeDefinition": "USAGE_CHARGESPM",
      "ChargeId": 300100192686413,
      "ChargePuid": "GP-5678-PRDT-1-CHRG-11",
      "CoveredLevelId": null,
      "PrePaymentNumber": null,
      "PricePeriodicity": "0zG",
      "PriceType": "RECURRING",
      "RollupFlag": null,
      "SequenceNumber": null,
      "SubscriptionId": 300100181994494,
      "SubscriptionProductId": 300100192686405,
      "ChargeName": "USAGE SPM CHARGE",
      "ExternalKey": null,
      "ExternalParentKey": null,
      "UnitListPrice": 20,
      "Allowance": null,
      "BlockSize": null,
      "TieredFlag": true,
      "TierType": null,
      "UsagePriceLockFlag": null,
      "PricePeriodicityName": "MONTH",
      "ChargeDefinitionName": null,
      "CreatedBy": "SALES_ADMIN",
      "CreationDate": "2019-08-20T08:13:16+00:00",
      "LastUpdateDate": "2019-08-20T08:13:16.685+00:00",
      "LastUpdateLogin": "9062D47DF31EDAF6E0533EFDF40A2696",
      "LastUpdatedBy": "SALES_ADMIN",
      "links":
			...
			},
...
Back to Top