Jump to

• Request
• Response
• Examples

Get a subscription metric

get

/crmRestApi/resources/11.13.18.05/subscriptionMetrics/{subscriptionMetricsUniqID}

Request

Path Parameters

• subscriptionMetricsUniqID(required): string
  This is the hash key of the attributes which make up the composite key for the Subscription Metrics resource and used to uniquely identify an instance of Subscription Metrics. The client should not generate the hash key value. Instead, the client should query on the Subscription Metrics collection resource in order to navigate to a specific instance of Subscription Metrics to get the hash key.

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 Top

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.

Body ()

Root Schema : subscriptionMetrics-item-response

Type: object

Show Source

• ClosedAmount: number
  Read Only: true

  The amount forfeited due to closed subscription in a given period.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who created the subscription metric record.
• CreationDate: string (date-time)
  Read Only: true

  The date when the subscription metric record was created.
• CreditedAmount: number
  Read Only: true

  The total credited amount for active subscriptions in a given period.
• DiscountAmount: number
  Title: Discount

  Read Only: true

  The total amount of discounts offered in a given period.
• EstimatedTax: number
  Title: Estimated Tax

  Read Only: true

  The total estimated tax amount for active subscriptions in a given period.
• InvoicedAmount: number
  Read Only: true

  The total invoiced amount for active subscriptions in a given period.
• LastUpdateDate: string (date-time)
  Read Only: true

  The date when the subscription metric record was last updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who has last updated the subscription metric record.
• LastUpdateLogin: string
  Read Only: true

  Maximum Length: 32

  The login of the user who last updated the subscription metric record.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MonthlyRecurringRevenue: number
  Title: MRR

  Read Only: true

  The total monthly recurring revenue for active subscriptions in a given period.
• MrrAmendContractions: number
  Title: Contraction MRR

  Read Only: true

  The total net monthly recurring revenue lost by amendments in a given period.
• MrrAmendExpansions: number
  Title: Expansion MRR

  Read Only: true

  The total net monthly recurring revenue gained by amendments in a given period.
• MrrChurnRenewLapses: number
  Title: Lapsed Renewal MRR

  Read Only: true

  The total net monthly recurring revenue of subscriptions that expired without any renewal in a given period.
• MrrClosedSubscriptions: number
  Title: Termination MRR

  Read Only: true

  The total net monthly recurring revenue lost due to terminations in a given period.
• MrrDueRenewal: number
  Title: MRR Due for Renewal

  Read Only: true

  The total net monthly recurring revenue due for renewal in a given period.
• MrrNewSubscriptions: number
  Title: New MRR

  Read Only: true

  The total net monthly recurring revenue of new subscriptions that started in a given period. These subscriptions aren't a result of amendments, renewals, and resumptions.
• MrrRenewActive: number
  Title: Activated Renewal MRR

  Read Only: true

  The total net monthly recurring revenue that were successfully renewed in a given period.
• MrrRenewChurn: number
  Title: Churned Renewal MRR

  Read Only: true

  The total net monthly recurring revenue of subscriptions which were renewed but got canceled in a given period.
• NumberClosedSubscriptions: number
  Title: Number of Terminated Subscriptions

  Read Only: true

  The total number of subscriptions terminated in a given period.
• NumberNewSubscriptions: number
  Title: Number of New Subscriptions

  Read Only: true

  The total number of new subscriptions that started in a given period. These subscriptions aren't a result of amendments, renewals and resumptions.
• NumberRenewedSubscriptions: number
  Title: Number of Renewed Subscriptions

  Read Only: true

  The total number of subscriptions that were renewed in a given period.
• NumberSubscriptions: number
  Title: Number of Subscriptions

  Read Only: true

  The total number of active subscriptions in a given period.
• PartyName: string
  Title: Party Name

  Read Only: true

  Maximum Length: 360

  The name of the party for which subscription metrics are sought.
• PartyNumber: string
  Title: Party Number

  Read Only: true

  Maximum Length: 30

  The number of the party for which subscription metrics are sought.
• PeriodCode: integer (int32)
  Read Only: true

  The code of the subscription metric snapshot period for which subscription metrics are sought.
• PeriodEndDate: string (date)
  Title: Period End Date

  Read Only: true

  The end date of the subscription metric snapshot period.
• PeriodMonth: number
  Title: Period Month

  Read Only: true

  The month of the subscription metric snapshot period. The valid values are integers one through 12.
• PeriodName: string
  Title: Period Name

  Read Only: true

  Maximum Length: 256

  The name of the subscription metric snapshot period.
• PeriodQuarter: number
  Title: Period Quarter

  Read Only: true

  The quarter of the subscription metric snapshot period.
• PeriodStartDate: string (date)
  Title: Period Start Date

  Read Only: true

  The start date of the subscription metric snapshot period.
• PeriodType: string
  Read Only: true

  Maximum Length: 4

  The default period type used for the partial period calculation.
• PeriodYear: number
  Title: Period Year

  Read Only: true

  The year of the subscription metric snapshot period. The valid values are 2019, 2020, and so on.
• PrimaryPartyId: integer (int64)
  Read Only: true

  The identifier of the primary party for which subscription metrics are sought.
• ProductNetPrice: number
  Title: Net Price

  Read Only: true

  The total contract value of active subscriptions in the given period.
• ProductTotal: number
  Title: Product Total

  Read Only: true

  The total value of active subscriptions in a given period.
• SuppressedCreditAmount: number
  Title: Suppressed Credit Amount

  Read Only: true

  The total credit amount that's suppressed based on the close credit method used for subscriptions terminated in a given period.
• TotalQuantity: number
  Title: Total Quantity

  Read Only: true

  The sum of quantities of active subscriptions in a given period.

{
    "type":"object",
    "properties":{
        "MrrAmendExpansions":{
            "title":"Expansion MRR",
            "type":"number",
            "description":"The total net monthly recurring revenue gained by amendments in a given period.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MrrDueRenewal":{
            "title":"MRR Due for Renewal",
            "type":"number",
            "description":"The total net monthly recurring revenue due for renewal in a given period.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PeriodType":{
            "maxLength":"4",
            "type":"string",
            "description":"The default period type used for the partial period calculation.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MonthlyRecurringRevenue":{
            "title":"MRR",
            "type":"number",
            "description":"The total monthly recurring revenue for active subscriptions in a given period.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "NumberClosedSubscriptions":{
            "title":"Number of Terminated Subscriptions",
            "type":"number",
            "description":"The total number of subscriptions terminated in a given period.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date when the subscription metric record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PeriodYear":{
            "title":"Period Year",
            "type":"number",
            "description":"The year of the subscription metric snapshot period. The valid values are 2019, 2020, and so on.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MrrChurnRenewLapses":{
            "title":"Lapsed Renewal MRR",
            "type":"number",
            "description":"The total net monthly recurring revenue of subscriptions that expired without any renewal in a given period.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PartyName":{
            "title":"Party Name",
            "maxLength":"360",
            "type":"string",
            "description":"The name of the party for which subscription metrics are sought.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PrimaryPartyId":{
            "type":"integer",
            "description":"The identifier of the primary party for which subscription metrics are sought.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "PeriodEndDate":{
            "title":"Period End Date",
            "type":"string",
            "description":"The end date of the subscription metric snapshot period.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ProductTotal":{
            "title":"Product Total",
            "type":"number",
            "description":"The total value of active subscriptions in a given period.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "NumberNewSubscriptions":{
            "title":"Number of New Subscriptions",
            "type":"number",
            "description":"The total number of new subscriptions that started in a given period. These subscriptions aren't a result of amendments, renewals and resumptions.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TotalQuantity":{
            "title":"Total Quantity",
            "type":"number",
            "description":"The sum of quantities of active subscriptions in a given period.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "NumberRenewedSubscriptions":{
            "title":"Number of Renewed Subscriptions",
            "type":"number",
            "description":"The total number of subscriptions that were renewed in a given period.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MrrRenewActive":{
            "title":"Activated Renewal MRR",
            "type":"number",
            "description":"The total net monthly recurring revenue that were successfully renewed in a given period.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PeriodCode":{
            "type":"integer",
            "description":"The code of the subscription metric snapshot period for which subscription metrics are sought.",
            "format":"int32",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"8"
            },
            "x-queryable":true
        },
        "MrrClosedSubscriptions":{
            "title":"Termination MRR",
            "type":"number",
            "description":"The total net monthly recurring revenue lost due to terminations in a given period.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who has last updated the subscription metric record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ProductNetPrice":{
            "title":"Net Price",
            "type":"number",
            "description":"The total contract value of active subscriptions in the given period.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the subscription metric record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "NumberSubscriptions":{
            "title":"Number of Subscriptions",
            "type":"number",
            "description":"The total number of active subscriptions in a given period.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PeriodQuarter":{
            "title":"Period Quarter",
            "type":"number",
            "description":"The quarter of the subscription metric snapshot period.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MrrRenewChurn":{
            "title":"Churned Renewal MRR",
            "type":"number",
            "description":"The total net monthly recurring revenue of subscriptions which were renewed but got canceled in a given period.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CreditedAmount":{
            "type":"number",
            "description":"The total credited amount for active subscriptions in a given period.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MrrNewSubscriptions":{
            "title":"New MRR",
            "type":"number",
            "description":"The total net monthly recurring revenue of new subscriptions that started in a given period. These subscriptions aren't a result of amendments, renewals, and resumptions.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EstimatedTax":{
            "title":"Estimated Tax",
            "type":"number",
            "description":"The total estimated tax amount for active subscriptions in a given period.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PeriodStartDate":{
            "title":"Period Start Date",
            "type":"string",
            "description":"The start date of the subscription metric snapshot period.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DiscountAmount":{
            "title":"Discount",
            "type":"number",
            "description":"The total amount of discounts offered in a given period.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PeriodMonth":{
            "title":"Period Month",
            "type":"number",
            "description":"The month of the subscription metric snapshot period. The valid values are integers one through 12.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ClosedAmount":{
            "type":"number",
            "description":"The amount forfeited due to closed subscription in a given period.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PartyNumber":{
            "title":"Party Number",
            "maxLength":"30",
            "type":"string",
            "description":"The number of the party for which subscription metrics are sought.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SuppressedCreditAmount":{
            "title":"Suppressed Credit Amount",
            "type":"number",
            "description":"The total credit amount that's suppressed based on the close credit method used for subscriptions terminated in a given period.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MrrAmendContractions":{
            "title":"Contraction MRR",
            "type":"number",
            "description":"The total net monthly recurring revenue lost by amendments in a given period.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PeriodName":{
            "title":"Period Name",
            "maxLength":"256",
            "type":"string",
            "description":"The name of the subscription metric snapshot period.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "InvoicedAmount":{
            "type":"number",
            "description":"The total invoiced amount for active subscriptions in a given period.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date when the subscription metric record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":"32",
            "type":"string",
            "description":"The login of the user who last updated the subscription metric record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Back to Top

Examples

The following example shows how to get a subscription metric by submitting a GET request on the REST resource.

cURL Command

curl -u <username:password> \
 -X GET https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/latest/subscriptionMetrics/100100350340130  \
 -H 'Content-Type: application/vnd.oracle.adf.resourceitem+json'  | json_pp

Example of Response Body

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

{
    "PartyName": "A T & T SOLUTIONS INC",
    "PartyNumber": "1001",
    "PrimaryPartyId": 1001,
    "PeriodType": "MNTH",
    "PeriodMonth": 4,
    "PeriodQuarter": 2,
    "PeriodYear": 2020,
    "PeriodStartDate": "2020-04-01",
    "PeriodEndDate": "2020-04-30",
    "PeriodCode": 2020204,
    "PeriodName": "2020 / 04",
    "ClosedAmount": 0,
    "CreditedAmount": 0,
    "DiscountAmount": 22317,
    "EstimatedTax": 857432.22,
    "InvoicedAmount": 0,
    "MonthlyRecurringRevenue": 278738.94,
    "MrrAmendContractions": 0,
    "MrrAmendExpansions": 0,
    "MrrChurnRenewLapses": 0,
    "MrrClosedSubscriptions": 0,
    "MrrDueRenewal": 0,
    "MrrNewSubscriptions": 28094.54,
    "MrrRenewActive": 0,
    "MrrRenewChurn": 0,
    "NumberClosedSubscriptions": 0,
    "NumberNewSubscriptions": 3,
    "NumberRenewedSubscriptions": 0,
    "NumberSubscriptions": 32,
    "ProductNetPrice": 4287161.13,
    "ProductTotal": 5144593.35,
    "SuppressedCreditAmount": 0,
    "TotalQuantity": 94,
    "CreatedBy": "FUSION_APPS_CRM_ESS_APPID",
    "CreationDate": "2021-06-28T18:44:09.415+00:00",
    "LastUpdatedBy": "FUSION_APPS_CRM_ESS_APPID",
    "LastUpdateDate": "2021-06-28T18:44:09.415+00:00",
    "LastUpdateLogin": "C5D694E7310A7A4AE0533DFDF40A90D5",
    "links": [
        {
            "rel": "self",
            "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/subscriptionMetrics/100100350340130",
            "name": "subscriptionMetrics",
            "kind": "item"
        },
        {
            "rel": "canonical",
            "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/subscriptionMetrics/100100350340130",
            "name": "subscriptionMetrics",
            "kind": "item"
        }
    ]
}

Back to Top