Jump to

• Request
• Response
• Examples

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: string
  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: string
  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 : subscriptionProfiles-item-response

Type: object

Show Source

• 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.
• CreateZeroCreditMemoFlag: boolean
  Title: Create 0 value credit memo for close

  Maximum Length: 1

  Indicates whether if a zero-value credit memo is created, if the calculated credit memo amount is 0.
• 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.
• CreditType: string
  Title: Credit Type

  Maximum Length: 30

  Indicates the type of credit issued to the customer on close and amend.
• 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
• EnableAdvBipTemplateFlag: boolean
  Title: Enable advanced configuration

  Maximum Length: 1

  Default Value: false

  Indicates whether advanced BIP configuration for usage invoice templates is enabled or not.
• 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.
• InvoiceBipReportCode: string
  Title: BIP Data Source

  Maximum Length: 30

  A BIP report template type for invoice attachments.
• 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.
• PreviewBipReportCode: string
  Title: BIP Data Source

  Maximum Length: 30

  The code of the BIP report template used for the subscription preview.
• 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.
• UsageEventAllowanceInvTemplate: string
  Title: Allowance

  Maximum Length: 200

  A template to use for the usage events allowance rating model.
• UsageEventCommitmentInvTemplate: string
  Title: Commitment

  Maximum Length: 200

  A template to use for the usage events commitment rating model.
• UsageEventEstimateInvTemplate: string
  Title: Estimate

  Maximum Length: 200

  A template to use for the usage events estimate rating model.
• UsageEventRegularInvTemplate: string
  Title: Basic

  Maximum Length: 200

  A template to use for the regular usage events rating model.
• UsageInvoiceLayoutTemplate: string
  Title: BIP 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

{
    "type":"object",
    "properties":{
        "AccountingRuleId":{
            "title":"Accounting Rule",
            "type":"integer",
            "description":"The unique identifier of the accounting rule.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            },
            "x-queryable":true
        },
        "AccountingRuleName":{
            "title":"Accounting Rule",
            "type":"string",
            "description":"Accounting Rule Name",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "BillService":{
            "title":"Bill Service",
            "maxLength":30,
            "type":"string",
            "description":"Indicates whether the subscription should be billed or not, or billed on renewal.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "BillingDateCode":{
            "title":"Billing Date",
            "maxLength":30,
            "type":"string",
            "description":"The code representing the billing date. The values are Period Start, Period End, Day, and Offset.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "BillingFrequency":{
            "title":"Billing Frequency",
            "maxLength":30,
            "type":"string",
            "description":"The billing frequency. The values are Month, Quarter, or Year.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "BillingOffsetDays":{
            "title":"Day or Offset",
            "type":"integer",
            "description":"The number of the billing date offset days.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "BillingSystem":{
            "title":"Billing System",
            "maxLength":30,
            "type":"string",
            "description":"The billing system. The values are Oracle Fusion or Third Party.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "CloseCreditMethod":{
            "title":"Close Credit Method",
            "maxLength":30,
            "type":"string",
            "description":"The credit method used at the time of closing a subscription.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "CoverageInvoiceList":{
            "title":"Attribute List",
            "type":"object",
            "description":"The list of items to be included in the coverage invoice.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "CoverageInvoiceText":{
            "title":"Coverage Invoice Text",
            "maxLength":4000,
            "type":"string",
            "description":"The text to be included in the coverage invoice.",
            "nullable":true,
            "default":"[$Product Name]: [$Charge Name] [$Bill from Date]-[$Bill to Date]",
            "x-queryable":true
        },
        "CreateZeroCreditMemoFlag":{
            "title":"Create 0 value credit memo for close",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether if a zero-value credit memo is created, if the calculated credit memo amount is 0.",
            "nullable":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreditMemoOption":{
            "title":"Credit Memo Option",
            "maxLength":30,
            "type":"string",
            "description":"The type of credit memo user wants to issue. Valid values are On Invoice, On Account, Mixed.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "CreditType":{
            "title":"Credit Type",
            "maxLength":30,
            "type":"string",
            "description":"Indicates the type of credit issued to the customer on close and amend.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "CustomerAcceptance":{
            "maxLength":30,
            "type":"string",
            "description":"The column  determines if customer acceptance is required forsubscription renewal.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "DefaultRevenueActionAmend":{
            "title":"Revenue Management Rule for Amendment",
            "maxLength":30,
            "type":"string",
            "description":"Default Revenue Action Amend",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "DefaultRevenueActionRenew":{
            "title":"Revenue Management Rule for Renewal",
            "maxLength":30,
            "type":"string",
            "description":"Default Revenue Action Renew",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "EnableAdvBipTemplateFlag":{
            "title":"Enable advanced configuration",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether advanced BIP configuration for usage invoice templates is enabled or not.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "EnableProrateByDayYn":{
            "title":"Prorate by day",
            "maxLength":1,
            "type":"string",
            "description":"The indicator of whether the product should be billed using daily rates proration.",
            "nullable":true,
            "x-queryable":true
        },
        "HeaderNumberPrefix":{
            "title":"Prefix",
            "maxLength":10,
            "type":"string",
            "description":"The prefix used while autonumbering the subscription.",
            "nullable":true,
            "x-queryable":true
        },
        "HeaderNumberSuffix":{
            "title":"Suffix",
            "maxLength":10,
            "type":"string",
            "description":"The suffix used while autonumbering the subscription.",
            "nullable":true,
            "x-queryable":true
        },
        "HeaderNumberingMethod":{
            "title":"Numbering Method",
            "maxLength":30,
            "type":"string",
            "description":"The numbering method while using autonumbering the subscription.",
            "nullable":true,
            "default":"ORA_PUID",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "InterfaceOffsetDays":{
            "title":"Billing Interface Offset Days",
            "type":"integer",
            "description":"The number of offset days.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":5
            },
            "x-queryable":true
        },
        "InternalApproval":{
            "maxLength":30,
            "type":"string",
            "description":"The column determines if internal approval is required for subscription renewal.",
            "nullable":true,
            "x-queryable":true
        },
        "InvoiceAttachmentCategory":{
            "title":"Invoice Attachment Category",
            "maxLength":30,
            "type":"string",
            "description":"The category of the invoice attachment associated with the subscription profile.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "InvoiceAttachmentEntityName":{
            "title":"Attachment Available On",
            "maxLength":30,
            "type":"string",
            "description":"The name of the invoice attachment entity associated with the subscription profile.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "InvoiceBipReportCode":{
            "title":"BIP Data Source",
            "maxLength":30,
            "type":"string",
            "description":"A BIP report template type for invoice attachments.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "InvoicingRuleId":{
            "title":"Invoicing Rule",
            "type":"integer",
            "description":"The invoicing rule associated with the subscription.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date when the 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 record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LayoutTemplate":{
            "title":"Contract Layout Template",
            "maxLength":200,
            "type":"string",
            "description":"The layout template that defines the formatting of the subscription information.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov",
                "dependencies":[
                    "PreviewBipReportCode"
                ]
            },
            "x-queryable":true
        },
        "LineAutonumberEnabledYn":{
            "title":"Automate subscription line numbering",
            "maxLength":1,
            "type":"string",
            "description":"Indicates if the line autonumber is enabled.",
            "nullable":true,
            "default":"N",
            "x-queryable":true
        },
        "NegotiationLanguage":{
            "title":"Language",
            "maxLength":4,
            "type":"string",
            "description":"The language in which the subscription negotiation and renewal information will be communicated.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "NumberingDeterminantType":{
            "title":"Determinant Type",
            "maxLength":30,
            "type":"string",
            "description":"The determinant type used while autonumbering the subscription.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"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.",
            "format":"int32",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "Offset":{
            "type":"number",
            "description":"The offset associated with the subscription profile.",
            "nullable":true,
            "x-queryable":true
        },
        "PartialPeriodStart":{
            "title":"Period Start",
            "maxLength":30,
            "type":"string",
            "description":"The partial period start date.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "PartialPeriodType":{
            "title":"Period Type",
            "maxLength":30,
            "type":"string",
            "description":"The partial period type. The values are Fixed and Actual.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "PaymentTermsId":{
            "title":"Payment Terms",
            "type":"integer",
            "description":"The unique identifier of the payment terms.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            },
            "x-queryable":true
        },
        "PaymentTermsName":{
            "title":"Payment Terms",
            "type":"string",
            "description":"Payment Terms Name",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "PenaltyChargeName":{
            "title":"Early Termination Fee Name",
            "maxLength":120,
            "type":"string",
            "description":"The heading for the penalty charge.",
            "nullable":true,
            "x-queryable":true
        },
        "PreviewBipReportCode":{
            "title":"BIP Data Source",
            "maxLength":30,
            "type":"string",
            "description":"The code of the BIP report template used for the subscription preview.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "PriceDuringBillingYn":{
            "title":"Allow pricing during billing",
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the subscription is priced during the billing.",
            "nullable":true,
            "default":"N",
            "x-queryable":true
        },
        "PricingApplicationCode":{
            "maxLength":30,
            "type":"string",
            "description":"The code associated with the pricing application.",
            "nullable":false,
            "default":"NULL",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "RevenueOptionAmend":{
            "title":"Accounting Option",
            "maxLength":30,
            "type":"string",
            "description":"Revenue Option Amend",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "RevenueOptionBillAdjustment":{
            "title":"Accounting Option",
            "maxLength":30,
            "type":"string",
            "description":"Revenue Option Bill Adjustment",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "RevenueOptionClose":{
            "title":"Accounting Option",
            "maxLength":30,
            "type":"string",
            "description":"Revenue Option Close",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "RevenueOptionPricingTerm":{
            "title":"Accounting Option",
            "maxLength":30,
            "type":"string",
            "description":"Revenue Option Pricing term",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "RevenueOptionRenew":{
            "title":"Accounting Option",
            "maxLength":30,
            "type":"string",
            "description":"Revenue Option Renew",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "RevenuePeriodBillAdjustment":{
            "title":"Effectivity Periods",
            "maxLength":30,
            "type":"string",
            "description":"Revenue Period Bill Adjustment",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "RevenuePeriodPricingTerm":{
            "title":"Effectivity Periods",
            "maxLength":30,
            "type":"string",
            "description":"Revenue Period  Pricing Term",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "SpecificDays":{
            "type":"number",
            "description":"The number of date to offset the subscription.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "SubscriptionInvoiceList":{
            "title":"Attribute List",
            "type":"object",
            "description":"The text to be included in the subscription invoice.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "SubscriptionInvoiceText":{
            "title":"Invoice Text",
            "maxLength":4000,
            "type":"string",
            "description":"The text to be included in the subscription invoice.",
            "nullable":true,
            "default":"[$Product Name]: [$Charge Name] [$Bill from Date]-[$Bill to Date]",
            "x-queryable":true
        },
        "SubscriptionProfileDescription":{
            "title":"Description",
            "maxLength":2000,
            "type":"string",
            "description":"The description of the subscription profile.",
            "nullable":true,
            "x-queryable":true
        },
        "SubscriptionProfileId":{
            "type":"integer",
            "description":"The unqiue identifier of the subscription profile.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SubscriptionProfileName":{
            "title":"Name",
            "maxLength":300,
            "type":"string",
            "description":"The name of the subscription profile.",
            "nullable":false,
            "x-queryable":true
        },
        "SubscriptionProfilePuid":{
            "title":"Subscription Profile PUID",
            "maxLength":120,
            "type":"string",
            "description":"Subscription Profile PUID",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "TransactionTypeName":{
            "title":"Transaction Type",
            "maxLength":80,
            "type":"string",
            "description":"The name of the transaction type.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "TransactionTypeSequenceId":{
            "title":"Transaction Type",
            "type":"integer",
            "description":"The unqiue identifier of the transaction type sequence.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            },
            "x-queryable":true
        },
        "UsageCapture":{
            "title":"Usage Capture Mode",
            "maxLength":30,
            "type":"string",
            "description":"Identify if the Billing System is FUSION or THIRD PARTY.",
            "nullable":false,
            "default":"ORA_THIRD_PARTY",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "UsageEventAllowanceInvTemplate":{
            "title":"Allowance",
            "maxLength":200,
            "type":"string",
            "description":"A template to use for the usage events allowance rating model.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov",
                "dependencies":[
                    "InvoiceBipReportCode"
                ]
            },
            "x-queryable":true
        },
        "UsageEventCommitmentInvTemplate":{
            "title":"Commitment",
            "maxLength":200,
            "type":"string",
            "description":"A template to use for the usage events commitment rating model.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov",
                "dependencies":[
                    "InvoiceBipReportCode"
                ]
            },
            "x-queryable":true
        },
        "UsageEventEstimateInvTemplate":{
            "title":"Estimate",
            "maxLength":200,
            "type":"string",
            "description":"A template to use for the usage events estimate rating model.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov",
                "dependencies":[
                    "InvoiceBipReportCode"
                ]
            },
            "x-queryable":true
        },
        "UsageEventRegularInvTemplate":{
            "title":"Basic",
            "maxLength":200,
            "type":"string",
            "description":"A template to use for the regular usage events rating model.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov",
                "dependencies":[
                    "InvoiceBipReportCode"
                ]
            },
            "x-queryable":true
        },
        "UsageInvoiceLayoutTemplate":{
            "title":"BIP Template",
            "maxLength":200,
            "type":"string",
            "description":"The layout template used for usage invoicing.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "WithholdProrationUsgYn":{
            "title":"Withhold proration of usage charges",
            "maxLength":1,
            "type":"string",
            "description":"Withhold Proration Usg Yn",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

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

• Array of: object link

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

Nested Schema : Attribute List

Type: object

Title: Attribute List

The text to be included in the subscription invoice.

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 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",

...
}

Back to Top