Get a subscription profile
get
/crmRestApi/resources/11.13.18.05/subscriptionProfiles/{SubscriptionProfileId}
Request
Path Parameters
-
SubscriptionProfileId(required): integer(int64)
The unqiue identifier of the subscription profile.
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 : subscriptionProfiles-item-response
Type:
Show Source
object
-
AccountingRuleId: integer
(int64)
Title:
Accounting Rule
The unique identifier of the accounting rule. -
AccountingRuleName: string
Title:
Accounting Rule
Accounting Rule Name -
BillingDateCode: string
Title:
Billing Date
Maximum Length:30
The code representing the billing date. The values are Period Start, Period End, Day, and Offset. -
BillingFrequency: string
Title:
Billing Frequency
Maximum Length:30
The billing frequency. The values are Month, Quarter, or Year. -
BillingOffsetDays: integer
(int64)
Title:
Day or Offset
The number of the billing date offset days. -
BillingSystem: string
Title:
Billing System
Maximum Length:30
The billing system. The values are Oracle Fusion or Third Party. -
BillService: string
Title:
Bill Service
Maximum Length:30
Indicates whether the subscription should be billed or not, or billed on renewal. -
CloseCreditMethod: string
Title:
Close Credit Method
Maximum Length:30
The credit method used at the time of closing a subscription. -
CoverageInvoiceList: object
Attribute List
Title:
Attribute List
The list of items to be included in the coverage invoice. -
CoverageInvoiceText: string
Title:
Coverage Invoice Text
Maximum Length:4000
Default Value:[$Product Name]: [$Charge Name] [$Bill from Date]-[$Bill to Date]
The text to be included in the coverage invoice. -
CreatedBy: string
Read Only:
true
Maximum Length:64
The user who created the record. -
CreationDate: string
(date-time)
Read Only:
true
The date when the record was created. -
CreditMemoOption: string
Title:
Credit Memo Option
Maximum Length:30
The type of credit memo user wants to issue. Valid values are On Invoice, On Account, Mixed. -
CustomerAcceptance: string
Maximum Length:
30
The column determines if customer acceptance is required forsubscription renewal. -
DefaultRevenueActionAmend: string
Title:
Revenue Management Rule for Amendment
Maximum Length:30
Default Revenue Action Amend -
DefaultRevenueActionRenew: string
Title:
Revenue Management Rule for Renewal
Maximum Length:30
Default Revenue Action Renew -
EnableProrateByDayYn: string
Title:
Prorate by day
Maximum Length:1
The indicator of whether the product should be billed using daily rates proration. -
HeaderNumberingMethod: string
Title:
Numbering Method
Maximum Length:30
Default Value:ORA_PUID
The numbering method while using autonumbering the subscription. -
HeaderNumberPrefix: string
Title:
Prefix
Maximum Length:10
The prefix used while autonumbering the subscription. -
HeaderNumberSuffix: string
Title:
Suffix
Maximum Length:10
The suffix used while autonumbering the subscription. -
InterfaceOffsetDays: integer
(int32)
Title:
Billing Interface Offset Days
The number of offset days. -
InternalApproval: string
Maximum Length:
30
The column determines if internal approval is required for subscription renewal. -
InvoiceAttachmentCategory: string
Title:
Invoice Attachment Category
Maximum Length:30
The category of the invoice attachment associated with the subscription profile. -
InvoiceAttachmentEntityName: string
Title:
Attachment Available On
Maximum Length:30
The name of the invoice attachment entity associated with the subscription profile. -
InvoicingRuleId: integer
(int64)
Title:
Invoicing Rule
The invoicing rule associated with the subscription. -
LastUpdateDate: string
(date-time)
Read Only:
true
The date when the record was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user who last updated the record. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
The login of the user who last updated the record. -
LayoutTemplate: string
Title:
Contract Layout Template
Maximum Length:200
The layout template that defines the formatting of the subscription information. -
LineAutonumberEnabledYn: string
Title:
Automate subscription line numbering
Maximum Length:1
Default Value:N
Indicates if the line autonumber is enabled. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
NegotiationLanguage: string
Title:
Language
Maximum Length:4
The language in which the subscription negotiation and renewal information will be communicated. -
NumberingDeterminantType: string
Title:
Determinant Type
Maximum Length:30
The determinant type used while autonumbering the subscription. -
ObjectVersionNumber: integer
(int32)
Read Only:
true
Used to implement optimistic locking. This number is incremented every time that the row is updated. The number is compared at the start and end of a transaction to detect whether another session has updated the row since it was queried. -
Offset: number
The offset associated with the subscription profile.
-
PartialPeriodStart: string
Title:
Period Start
Maximum Length:30
The partial period start date. -
PartialPeriodType: string
Title:
Period Type
Maximum Length:30
The partial period type. The values are Fixed and Actual. -
PaymentTermsId: integer
(int64)
Title:
Payment Terms
The unique identifier of the payment terms. -
PaymentTermsName: string
Title:
Payment Terms
Payment Terms Name -
PenaltyChargeName: string
Title:
Early Termination Fee Name
Maximum Length:120
The heading for the penalty charge. -
PriceDuringBillingYn: string
Title:
Allow pricing during billing
Maximum Length:1
Default Value:N
Indicates whether the subscription is priced during the billing. -
PricingApplicationCode: string
Maximum Length:
30
Default Value:NULL
The code associated with the pricing application. -
RevenueOptionAmend: string
Title:
Accounting Option
Maximum Length:30
Revenue Option Amend -
RevenueOptionBillAdjustment: string
Title:
Accounting Option
Maximum Length:30
Revenue Option Bill Adjustment -
RevenueOptionClose: string
Title:
Accounting Option
Maximum Length:30
Revenue Option Close -
RevenueOptionPricingTerm: string
Title:
Accounting Option
Maximum Length:30
Revenue Option Pricing term -
RevenueOptionRenew: string
Title:
Accounting Option
Maximum Length:30
Revenue Option Renew -
RevenuePeriodBillAdjustment: string
Title:
Effectivity Periods
Maximum Length:30
Revenue Period Bill Adjustment -
RevenuePeriodPricingTerm: string
Title:
Effectivity Periods
Maximum Length:30
Revenue Period Pricing Term -
SpecificDays: number
The number of date to offset the subscription.
-
SubscriptionInvoiceList: object
Attribute List
Title:
Attribute List
The text to be included in the subscription invoice. -
SubscriptionInvoiceText: string
Title:
Invoice Text
Maximum Length:4000
Default Value:[$Product Name]: [$Charge Name] [$Bill from Date]-[$Bill to Date]
The text to be included in the subscription invoice. -
SubscriptionProfileDescription: string
Title:
Description
Maximum Length:2000
The description of the subscription profile. -
SubscriptionProfileId: integer
(int64)
Read Only:
true
The unqiue identifier of the subscription profile. -
SubscriptionProfileName: string
Title:
Name
Maximum Length:300
The name of the subscription profile. -
SubscriptionProfilePuid: string
Title:
Subscription Profile PUID
Maximum Length:120
Subscription Profile PUID -
TransactionTypeName: string
Title:
Transaction Type
Maximum Length:80
The name of the transaction type. -
TransactionTypeSequenceId: integer
(int64)
Title:
Transaction Type
The unqiue identifier of the transaction type sequence. -
UsageCapture: string
Title:
Usage Capture Mode
Maximum Length:30
Default Value:ORA_THIRD_PARTY
Identify if the Billing System is FUSION or THIRD PARTY. -
UsageInvoiceLayoutTemplate: string
Title:
Usage Events Invoice Template
Maximum Length:200
The layout template used for usage invoicing. -
WithholdProrationUsgYn: string
Title:
Withhold proration of usage charges
Maximum Length:1
Withhold Proration Usg Yn
Nested Schema : Attribute List
Type:
object
Title:
Attribute List
The list of items to be included in the coverage invoice.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Attribute List
Type:
object
Title:
Attribute List
The text to be included in the subscription invoice.
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.
Examples
The following example shows how to get a subscription profile by submitting a GET request on the REST resource using cURL.
cURL Command
curl --user
sales_cloud_user https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/subscriptionProfiles/300100181512584
Example of Response Body
{ "SubscriptionProfileId": 300100181512584, "SubscriptionProfileName": "zOSS_PM_ALMMeters_NO_UsageCapture", "SubscriptionProfileDescription": "zOSS_PM_ALMMeters_NO_UsageCapture", "BillService": "ORA_BILL", "InvoicingRuleId": -2, "BillingFrequency": "0zG", "BillingDateCode": "ORA_PERIOD_START", "BillingOffsetDays": null, "AccountingRuleId": 300100033038414, "PaymentTermsId": 4, "PartialPeriodType": "ORA_ACTUAL", "PartialPeriodStart": "ORA_SERVICE", "CloseCreditMethod": "ORA_PRORATE_WITH_CREDIT", "SubscriptionInvoiceText": "[$Product Name]: [$Charge Name] [$Bill from Date]-[$Bill to Date]", "TransactionTypeSequenceId": 34, "TransactionTypeName": "Invoice", "ObjectVersionNumber": 1, "CreatedBy": "CONMGR", "CreationDate": "2019-08-30T07:26:30+00:00", "LastUpdatedBy": "CONMGR", "LastUpdateDate": "2019-08-30T07:27:26.433+00:00", "LastUpdateLogin": "910A52A0131B9F95E053A15AF00A0D49", "PricingApplicationCode": "NULL", "PriceDuringBillingYn": "N", "CustomerAcceptance": null, "InternalApproval": null, "Offset": null, "SpecificDays": null, "LayoutTemplate": null, "NegotiationLanguage": null, "CoverageInvoiceText": "[$Product Name]: [$Charge Name] [$Bill from Date]-[$Bill to Date]", "InterfaceOffsetDays": null, "BillingSystem": "ORA_OSS_FUSION", "UsageCapture": "ORA_THIRD_PARTY", "PenaltyChargeName": null, "LineAutonumberEnabledYn": "N", ... }