Subscription REST Documentation

Subscription Management
REST Documentation
Release 19.10 (19D)
Subscription Management REST Documentation
Contents
Subscriptions ................................................................................................................................................. 6
Create a Subscription ................................................................................................................................ 6
Creation of a Subscription with a product, charges and a charge discount ............................................. 9
Update a Subscription............................................................................................................................. 31
Delete a Subscription .............................................................................................................................. 34
Get a Subscription ................................................................................................................................... 34
Get Subscriptions .................................................................................................................................... 37
Activate a Subscription (Custom)............................................................................................................ 40
Preview a Subscription (Custom) ............................................................................................................ 40
Renew a Subscription (Custom) .............................................................................................................. 43
Cancel a Subscription (Custom) .............................................................................................................. 44
Close a Subscription (Custom) ................................................................................................................ 44
Hold a Subscription (Custom) ................................................................................................................. 45
Remove Hold on a Subscription (Custom) .............................................................................................. 46
Subscription Parties .................................................................................................................................... 46
Create a Subscription Party .................................................................................................................... 46
Delete a Subscription Party..................................................................................................................... 47
Get a Subscription Party ......................................................................................................................... 48
Get Subscription Parties.......................................................................................................................... 48
Subscription Party Contacts ........................................................................................................................ 49
Create a Subscription Party Contact ....................................................................................................... 49
Delete a Subscription Party Contact ....................................................................................................... 51
Get a Subscription Party Contact ............................................................................................................ 51
Get Subscription Party Contacts ............................................................................................................. 52
Subscription Sales Credits ........................................................................................................................... 53
Create a Subscription Sales Credit .......................................................................................................... 53
Update a Subscription Sales Credit ......................................................................................................... 54
2|Page
Delete a Subscription Sales Credit .......................................................................................................... 55

Get a Subscription Sales Credit ............................................................................................................... 55
Get Subscription Sales Credits ................................................................................................................ 56
Subscription Products ................................................................................................................................. 57
Create a Subscription Product ................................................................................................................ 57
Update a Subscription Product ............................................................................................................... 60
Delete a Subscription Product ................................................................................................................ 63
Get a Subscription Product ..................................................................................................................... 63
Get Subscription Products ...................................................................................................................... 65
Cancel a Subscription Product (Custom)................................................................................................. 68
Close a Subscription Product (Custom)................................................................................................... 69
Hold a Subscription Product (Custom).................................................................................................... 69
Remove Hold on a Subscription Product (Custom) ................................................................................ 70
Suspend a Subscription Product (Custom).............................................................................................. 71
Resume a Subscription Product (Custom) .............................................................................................. 71
Subscription Product Covered Levels ......................................................................................................... 72
Create a Subscription Product Covered Level......................................................................................... 72
Update a Subscription Product Covered Level ....................................................................................... 74
Delete a Subscription Product Covered Level ......................................................................................... 76
Get a Subscription Product Covered Level ............................................................................................. 76
Get Subscription Product Covered Levels ............................................................................................... 78
Cancel a Subscription Product Covered Level (Custom) ......................................................................... 79
Close a Subscription Product Covered Level (Custom) ........................................................................... 81
Subscription Product Charges ..................................................................................................................... 82
Create a Subscription Product Charge .................................................................................................... 82
Update a Subscription Product Charge ................................................................................................... 83
Delete a Subscription Product Charge .................................................................................................... 85
Get a Subscription Product Charge ......................................................................................................... 85
Get Subscription Product Charges .......................................................................................................... 86
Subscription Product Charge Adjustments ................................................................................................. 88
Create a Product Charge Adjustment ..................................................................................................... 88
Update a Product Charge Adjustment .................................................................................................... 89
3|Page
Delete a Product Charge Adjustment ..................................................................................................... 90

Get a Product Charge Adjustment .......................................................................................................... 91
Get Product Charge Adjustments ........................................................................................................... 92
Subscription Product Bill Lines .................................................................................................................... 93
Create a Subscription Product Bill Line ................................................................................................... 93
Update a Subscription Product Bill Line.................................................................................................. 94
Update a Subscription Product Bill Line for Usage Quantity .................................................................. 96
Delete a Subscription Product Bill Line ................................................................................................... 97
Get a Subscription Product Bill Line ........................................................................................................ 98
Get Subscription Product Bill Lines ......................................................................................................... 99
Subscription Product Bill Line Adjustments .............................................................................................. 100
Create a Subscription Product Bill Line Adjustment ............................................................................. 100
Update a Subscription Product Bill Line Adjustment ............................................................................ 101
Delete a Subscription Product Bill Line Adjustment ............................................................................. 102
Get a Subscription Product Bill Line Adjustments ................................................................................ 103
Get Subscription Product Bill Line Adjustments ................................................................................... 104
Subscription Product Sales Credits ........................................................................................................... 105
Create a Subscription Product Sales Credit .......................................................................................... 105
Update a Subscription Product Sales Credit ......................................................................................... 106
Delete a Subscription Product Sales Credit .......................................................................................... 107
Get a Subscription Product Sales Credit ............................................................................................... 107
Get Subscription Product Sales Credits................................................................................................. 108
Subscription Covered Level Charges ......................................................................................................... 109
Create a Subscription Covered Level Charge ........................................................................................ 109
Update a Subscription Covered Level Charge ....................................................................................... 110
Delete a Subscription Covered Level Charge ........................................................................................ 111
Get a Subscription Covered Level Charge ............................................................................................. 112
Get Subscription Covered Level Charges .............................................................................................. 113
Subscription Covered Level Charge Adjustments ..................................................................................... 114
Create a Covered Level Charge Adjustment ......................................................................................... 114
Update a Covered Level Charge Adjustment ........................................................................................ 116
Delete a Covered Level Charge Adjustment ......................................................................................... 117
4|Page
Get a Covered Level Charge Adjustment .............................................................................................. 117

Get Covered Level Charge Adjustments ............................................................................................... 118
Subscription Covered Level Bill Lines ........................................................................................................ 119
Create a Covered Level Bill Line ............................................................................................................ 119
Update a Covered Level Bill Line........................................................................................................... 121
Delete a Covered Level Bill Line ............................................................................................................ 122
Get a Covered Level Bill Line ................................................................................................................. 122
Get Covered Level Bill Lines .................................................................................................................. 124
Subscription Covered Level Bill Line Adjustments .................................................................................... 125
Create a Covered Level Bill Line Adjustment ........................................................................................ 125
Update a Covered Level Bill Line Adjustment ....................................................................................... 126
Delete a Covered Level Bill Line Adjustment ........................................................................................ 127
Get a Covered Level Bill Line Adjustments ........................................................................................... 128
Get Covered Level Bill Line Adjustments .............................................................................................. 129
Asset Transactions .................................................................................................................................... 130
Asset Creation ....................................................................................................................................... 131
Asset Expiration .................................................................................................................................... 134
Asset Reinstation .................................................................................................................................. 137
Asset Transfer ....................................................................................................................................... 140
Asset Return .......................................................................................................................................... 141
Asset Split .............................................................................................................................................. 142
5|Page
Subscriptions
Create a Subscription
Method: POST
URI: /crmRestApi/resources/11.13.18.05/subscriptions
Media Type: application/vnd.oracle.adf.resourceitem+json, application/json
Example:
https://zcmw.fa.dc1.c9dev2.oraclecorp.com:443/crmRestApi/resources/11.13.18.05/subscriptions
Request Body:
{
"SubscriptionNumber": "GP-5678",
"BusinessUnitId": 204,
"LegalEntityId": 204,
"SubscriptionProfileId": 300100172161473,
"PrimaryPartyId": 1001,
"Currency": "USD",
"StartDate": "2019-01-01",
"EndDate": "2019-12-31",
"DefinitionOrganizationId": 204,
"BillToAccountId": 1001,
"BillToAccountNumber": "1001",
"BillToSiteUseId": 1006
}
Response Body:
{
"SubscriptionId": 300100177254423,
"BusinessUnitName": "Vision Operations",
"LegalEntityName": "Vision Operations",
"SubscriptionProfileName": "zOSS_SP_ServiceStartActual_Advance_Month",
"PrimaryPartyName": "A T & T SOLUTIONS INC",
"PricedOnDate": "2019-06-04T00:00:00+00:00",
"PricingStrategyId": null,
"PricingStrategyExplanation": null,
"PricingSegment": null,
"PricingSegmentExplanation": null,
"SegmentExplanationMessage": null,
"Currency": "USD",
6|Page
"CurrencyName": "US Dollar",

"CurrencyConversionRate": null,
"CurrencyConversionRateType": null,
"CurrencyConversionRateDate": null,
"StartDate": "2019-01-01",
"Duration": 1,
"Period": "0zE",
"EndDate": "2019-12-31",
"PartialPeriodType": "ORA_ACTUAL",
"PartialPeriodStart": "ORA_SERVICE",
"CloseReason": null,
"ClosedDate": null,
"CloseCreditMethod": null,
"ApprovalNote": null,
"CancelReason": null,
"CanceledDate": null,
"ApprovedDate": null,
"RenewedDate": null,
"ShortDescription": null,
"Description": null,
"Status": "ORA_DRAFT",
"UserStatus": null,
"BillService": "ORA_BILL",
"BillServiceName": "Bill",
"InvoicingRuleId": -2,
"InvoicingRuleName": "Advance Invoice",
"BillingDateCode": "ORA_PERIOD_START",
"BillingDateName": "Period start",
"BillOnDay": null,
"BillingOffsetDays": null,
"BillingFrequency": "0zG",
"BillingFrequencyName": "MONTH",
"AccountingRuleId": 300100033038413,
"AccountingRuleName": "3 Months, Deferred",
"TransactionTypeName": "ORA_OSS_Invoice",
"BillingSystem": null,
"SubscriptionInvoiceText": "[$Item Name]: [$Charge Name] [$Bill from
Date]-[$Bill to Date]",
"CoverageInvoiceText": null,
"BillToAccountDescription": "A T & T SOLUTIONS INC",
"BillToSiteUseId": 1006,
"BillToAddress": "32 Ave of the Americas,NEW YORK, NY 10013",
"ShipToParty": null,
"ShipToPartyName": null,
"ShipToPartySiteId": null,
"ShipToSite": null,
"PaymentMethod": null,
"PaymentMethodName": null,
"PONumber": null,
"WireNumber": null,
"PaymentTermsId": 1064,
"PaymentTermsName": "Immediate",
"TaxClassificationCode": null,
"TaxClassificationMeaning": null,
7|Page
"ExemptCertificateNumber": null,
"ExemptReason": null,
"ExemptReasonMeaning": null,
"TaxExemptionHandling": "S",
"TaxExemptionHandlingName": "Standard",
"DocumentFiscalClassification": null,
"CustomerAcceptance": null,
"InternalApproval": "REQUIRED",
"LayoutTemplate": null,
"CommunicationChannel": null,
"PrimarySalesPerson": null,
"NegotiationLanguage": null,
"QuoteToContactId": null,
"EnableRenewalRemindersFlag": null,
"RenewalProcess": null,
"DaysBeforeExpiry": null,
"QuoteToCcEmail": null,
"RenewalPricingMethodUsed": null,
"RenewalProcessUsed": null,
"PriceAdjustmentPercentUsed": null,
"DaysBeforeExpiryUsed": null,
"AssigneeId": null,
"AssigneeType": null,
"TotalContractValue": null,
"EstimatedTax": null,
"CreditedAmount": null,
"ClosedAmount": null,
"CanceledAmount": null,
"InvoicedAmount": null,
"SourceSystem": null,
"SourceKey": null,
"SourceNumber": null,
"RenewalTemplateId": null,
"NotificationTemplateId": null,
"RenewalSubscriptionProfileId": null,
"DefaultLanguage": null,
"GenerateBillingSchedule": null,
"TransactionType": "ORA_SUBSCRIPTION",
"PricingSystem": "ORA_FUSION",
"PricingError": null,
"CorpCurrencyCode": "USD",
"CurcyConvRateType": "Corporate",
"RenewalCustomerAcceptance": null,
"RenewalInternalApproval": null,
"RenewalPriceAdjustmentBasis": null,
"RenewalPriceAdjustmentPercent": null,
"RenewalPriceAdjustmentType": null,
"AttachmentEntityName": "OSS_DOC_SUBSCRIPTION_AGREEMENT",
"AttachmentEntityName1": "OSS_DOC_SUPPORTING_DOCUMENTS",
"CreatedBy": "CONMGR",
"CreationDate": "2019-06-04T04:25:03+00:00",
"LastUpdatedBy": "CONMGR",
"LastUpdateDate": "2019-06-04T04:25:08.405+00:00",
"LastUpdateLogin": "8A5689BEEA6839CBE05322EAF40A0656",
...
}
8|Page
Creation of a Subscription with a product, charges and a charge discount
Request Body:
{
"Currency": "USD",
"StartDate": "2020-01-30",
"EndDate": "2021-01-29",
"CustomerAcceptance":"NOTREQUIRED",
"InternalApproval":"NOTREQUIRED",
"GenerateBillingSchedule": "Y",
"products":[
{
"LineNumber":"P1",
"ProductName":"Cloud Backup Service",
"Quantity":1,
"charges":[
{
"ChargeDefinition":"QP_SALE_PRICE",
"ChargeName": "Activation Fee",
"PriceType":"ONE_TIME",
"PricePeriodicity":"0zG",
"UnitListPrice":500,
"adjustments":[
{
"AdjustmentType":
"ORA_DISCOUNT_AMOUNT",
"AdjustmentValue": 50,
"Reason": "Special festival offer",
"SequenceNumber": 1,
"AdjustmentName": "Spl Discount",
"Effectivity": "ORA_ALL_TERM"
}
]
},
{
"ChargeDefinition":"QP_RECURRING_SALE_PRICE",
"ChargeName": "Monthly Recurring Fee",
"PriceType":"RECURRING",
"PricePeriodicity":"0zG",
"UnitListPrice":5.99
}
]
}
]
}
9|Page
Response Body:
{
"SubscriptionProfileName": "zOSS_SP_CalendarMonthActual_Advance_Month",
"PricedOnDate": "2020-01-30T00:00:00+00:00",
"Currency": "USD",
"StartDate": "2020-01-30",
"Duration": 1,
"Period": "0zE",
"EndDate": "2021-01-29",
"DefinitionOrganizationName": "Vision Operations",
"PartialPeriodStart": "ORA_CALENDAR",
"ClosedDate": null,
"UserStatus": null,
"BillOnDay": null,
10 | P a g e
"SubscriptionInvoiceText": "[$Item Name]: [$Charge Name] [$Bill from Date]-
[$Bill to Date]",
"BillToAddress": "32 Ave of the Americas , , New York10013 , NY",
"ShipToSite": null,
"PONumber": null,
"WireNumber": null,
"CustomerAcceptance": "NOTREQUIRED",
"InternalApproval": "NOTREQUIRED",
"AssigneeId": null,
"SourceKey": null,
11 | P a g e
"CreationDate": "2020-01-30T16:26:03+00:00",
"LastUpdateLogin": "9CD631AD91BF8018E05322EAF40AD740",
"CustomerTrxTypeSequenceId": null,
"UsageCapture": "ORA_THIRD_PARTY",
"products": [
{
"SubscriptionProductId": 300100184871792,
"LineNumber": "P1",
"SubscriptionProductPuid": "GP-3333-PRDT-7004",
"SalesProductType": "SUBSCRIPTION",
"Description": "Cloud Backup Service",
"InventoryItemId": 300100178580511,
"ItemUnitOfMeasure": "Ea",
"ProductName": "Cloud Backup Service",
"Quantity": 1,
"StartDate": "2020-01-30",
"EndDate": "2021-01-29",
"ClosedDate": null,
"PriceListId": null,
"UnitPrice": null,
"Currency": "USD",
"BillOnDay": null,
12 | P a g e
"InvoiceText": "[$Item Name]: [$Charge Name] [$Bill from Date]-

[$Bill to Date]",
"BillToAddress": "32 Ave of the Americas , , New York10013 , NY",
"ShipToPartyId": null,
"ShipToPartySiteName": null,
"PONumber": null,
"WireNumber": null,
"PrePaymentNumber": null,
"OutputTaxClassification": null,
"ProductFiscClassification": null,
"TaxError": null,
"CoverageScheduleId": null,
"RenewalType": "RENEW",
"PriceAsOf": "2020-01-30",
"PriceTransactionOn": "2020-01-30",
"SourceKey": null,
"SourceLineKey": null,
"SourceLineNumber": null,
"MonthlyRecurringRevenue": null,
"Duration": 1,
"Period": "0zE",
"ExternalAssetKey": null,
"ExternalParentAssetKey": null,
"ExternalPriceListId": null,
"ExternalRootAssetKey": null,
"PriceListName": null,
"NextPricingDate": null,
"PricingTermsStartDate": null,
"PricingTermsPricingMethod": null,
"PricingTermsPeriod": null,
"PricingTermsDuration": null,
13 | P a g e
"PricingTermsAdjustmentPCT": null,
"AmendCreditMethod": null,
"AmendCreditMethodName": null,
"AmendDescription": null,
"AmendEffectiveDate": null,
"AmendReason": null,
"AmendReasonName": null,
"StatusMeaning": "Draft",
"EnablePricingTermsFlag": null,
"NextBillStartDate": null,
"CreationDate": "2020-01-30T16:26:03.607+00:00",
"SummarizedBillingFlag": null,
"InterfaceOffsetDays": null,
"CoverageName": null,
"SuspendReason": null,
"SuspendedDate": null,
"SuspendCreditMethod": null,
"ResumeDate": null,
"ResumeDuration": null,
"ResumePeriod": null,
"AutoExtendFlag": null,
"ChurnProbability": null,
"charges": [
{
"BillLineId": null,
"ChargeDefinition": "QP_SALE_PRICE",
"ChargeId": 300100184871793,
"ChargePuid": "GP-3333-PRDT-7004-CHRG-6006",
"CoveredLevelId": null,
"PricePeriodicity": "0zG",
"PriceType": "ONE_TIME",
"RollupFlag": null,
"SequenceNumber": null,
"ExternalKey": null,
"ExternalParentKey": null,
"UnitListPrice": 500,
"Allowance": null,
"BlockSize": null,
"TieredFlag": false,
"TierType": null,
"UsagePriceLockFlag": null,
"PricePeriodicityName": "MONTH",
"ChargeDefinitionName": null,
"CreationDate": "2020-01-30T16:26:03.808+00:00",
14 | P a g e
"MeterDefinitionId": null,
"MeterId": null,
"InitialMeterReadingId": null,
"AggregationMethod": null,
"AssetMeterYn": null,
"adjustments": [
{
"ChargeAdjustmentId": 300100184871794,
"ChargeAdjustmentPuid": "GP-3333-PRDT-7004-CHRG-6006-MADJ-
2003",
"ChargeId": 300100184871793,
"PeriodFrom": null,
"PeriodUntil": null,
"AdjustmentType": "ORA_DISCOUNT_AMOUNT",
"AdjustmentBasis": null,
"Reason": "Special festival offer",
"AdjustmentName": "Spl Discount",
"AutoAdjustmentFlag": null,
"Effectivity": "ORA_ALL_TERM",
"NumberOfPeriods": null,
"ObjectVersionNumber": 1,
"CreationDate": "2020-01-30T16:26:03.971+00:00",
"links": [
{
"rel": "self",
"href": "https://faehyp88.fa.dc1.c9dev2.oraclecorp.com:443/
crmRestApi/resources/11.13.18.05/subscriptions/GP-3333/child/products/GP-
3333-PRDT-7004/child/charges/GP-3333-PRDT-7004-CHRG-
6006/child/adjustments/GP-3333-PRDT-7004-CHRG-6006-MADJ-2003",
"name": "adjustments",
"kind": "item",
"properties": {
"changeIndicator": "ACED0005737200136A6176612E7574696C2E4
1727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001
737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7
565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B020000787000000001
78"
}
},
{
"rel": "canonical",
6006/child/adjustments/GP-3333-PRDT-7004-CHRG-6006-MADJ-2003",
"kind": "item"
15 | P a g e
},
{
"rel": "parent",
3333-PRDT-7004/child/charges/GP-3333-PRDT-7004-CHRG-6006",
"name": "charges",
"kind": "item"
},
{
"rel": "lov",
6006/child/adjustments/GP-3333-PRDT-7004-CHRG-6006-MADJ-
2003/lov/AdjustmentBasisLookupVA",
"name": "AdjustmentBasisLookupVA",
"kind": "collection"
},
{
"rel": "lov",
2003/lov/AdjustmentEffectivityLookupVA",
"name": "AdjustmentEffectivityLookupVA",
},
{
"rel": "lov",
2003/lov/AdjustmentTypeLookupVA",
"name": "AdjustmentTypeLookupVA",
}
]
}
],
"links": [
{
"rel": "self",
"href": "https://faehyp88.fa.dc1.c9dev2.oraclecorp.com:443/crmR
estApi/resources/11.13.18.05/subscriptions/GP-3333/child/products/GP-3333-
PRDT-7004/child/charges/GP-3333-PRDT-7004-CHRG-6006",
"name": "charges",
"kind": "item",
"properties": {
261794C6973747881D21D99C7619D03000149000473697A657870000000017704000000017372
00116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C75657
87200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
}
},
16 | P a g e
{
"rel": "canonical",
"name": "charges",
"kind": "item"
},
{
"rel": "parent",
PRDT-7004",
"name": "products",
"kind": "item"
},
{
"rel": "lov",
PRDT-7004/child/charges/GP-3333-PRDT-7004-CHRG-6006/lov/PaymentSetIdVA",
"name": "PaymentSetIdVA",
},
{
"rel": "lov",
PRDT-7004/child/charges/GP-3333-PRDT-7004-CHRG-6006/lov/TierTypePVO",
"name": "TierTypePVO",
},
{
"rel": "child",
PRDT-7004/child/charges/GP-3333-PRDT-7004-CHRG-6006/child/adjustments",
},
{
"rel": "child",
PRDT-7004/child/charges/GP-3333-PRDT-7004-CHRG-6006/child/chargeTiers",
"name": "chargeTiers",
}
]
},
{
"BillLineId": null,
"ChargeDefinition": "QP_RECURRING_SALE_PRICE",
"ChargeId": 300100184871795,
17 | P a g e
"PriceType": "RECURRING",
"RollupFlag": null,
"ChargeName": "Monthly Recurring Fee",
"UnitListPrice": 5.99,
"Allowance": null,
"BlockSize": null,
"TierType": null,
"CreationDate": "2020-01-30T16:26:04.121+00:00",
"MeterDefinitionId": null,
"MeterId": null,
"InitialMeterReadingId": null,
"AggregationMethod": null,
"AssetMeterYn": null,
"links": [
{
"rel": "self",
"name": "charges",
"kind": "item",
"properties": {
261794C6973747881D21D99C7619D03000149000473697A657870000000017704000000017372
00116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C75657
87200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
}
},
{
"rel": "canonical",
"name": "charges",
"kind": "item"
},
{
"rel": "parent",
PRDT-7004",
"name": "products",
"kind": "item"
18 | P a g e
},
{
"rel": "lov",
PRDT-7004/child/charges/GP-3333-PRDT-7004-CHRG-6007/lov/PaymentSetIdVA",
},
{
"rel": "lov",
PRDT-7004/child/charges/GP-3333-PRDT-7004-CHRG-6007/lov/TierTypePVO",
"name": "TierTypePVO",
},
{
"rel": "child",
PRDT-7004/child/charges/GP-3333-PRDT-7004-CHRG-6007/child/adjustments",
},
{
"rel": "child",
PRDT-7004/child/charges/GP-3333-PRDT-7004-CHRG-6007/child/chargeTiers",
"name": "chargeTiers",
}
]
}
],
"links": [
{
"rel": "self",
"href": "https://faehyp88.fa.dc1.c9dev2.oraclecorp.com:443/crmRestA
pi/resources/11.13.18.05/subscriptions/GP-3333/child/products/GP-3333-PRDT-
7004",
"name": "products",
"kind": "item",
"properties": {
94C6973747881D21D99C7619D03000149000473697A6578700000000177040000000173720011
6A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C756578720
0106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
}
},
{
"rel": "canonical",
7004",
"name": "products",
19 | P a g e
"kind": "item"
},
{
"rel": "parent",
pi/resources/11.13.18.05/subscriptions/GP-3333",
"name": "subscriptions",
"kind": "item"
},
{
"rel": "lov",
7004/lov/BillingDateCodeVA",
"name": "BillingDateCodeVA",
},
{
"rel": "lov",
7004/lov/SubscriptionCoverageHeaderVA",
"name": "SubscriptionCoverageHeaderVA",
},
{
"rel": "lov",
7004/lov/AmendCreditMethodVA",
"name": "AmendCreditMethodVA",
},
{
"rel": "lov",
7004/lov/AccountingRuleVA",
"name": "AccountingRuleVA",
},
{
"rel": "lov",
7004/lov/ShipToPartyVA",
"name": "ShipToPartyVA",
},
{
"rel": "lov",
7004/lov/PaymentTermsVA",
"name": "PaymentTermsVA",
},
20 | P a g e
{
"rel": "lov",
7004/lov/PeriodVA",
"name": "PeriodVA",
},
{
"rel": "lov",
7004/lov/TaxExemptionControlVA",
"name": "TaxExemptionControlVA",
},
{
"rel": "lov",
7004/lov/ItemNameVA",
"name": "ItemNameVA",
},
{
"rel": "lov",
7004/lov/BillToAccountVA",
"name": "BillToAccountVA",
},
{
"rel": "lov",
7004/lov/PaymentMethodVA",
"name": "PaymentMethodVA",
},
{
"rel": "lov",
7004/lov/PaymentSetIdVA",
},
{
"rel": "lov",
7004/lov/AmendReasonVA",
"name": "AmendReasonVA",
},
{
21 | P a g e
"rel": "lov",
7004/lov/BillingDayLOVVO",
"name": "BillingDayLOVVO",
},
{
"rel": "lov",
7004/lov/InvoiceRuleVA",
"name": "InvoiceRuleVA",
},
{
"rel": "lov",
7004/lov/RenewalTypeVA",
"name": "RenewalTypeVA",
},
{
"rel": "lov",
7004/lov/PricingMethodVA",
"name": "PricingMethodVA",
},
{
"rel": "lov",
7004/lov/TimeUnitOfMeasureVA",
"name": "TimeUnitOfMeasureVA",
},
{
"rel": "lov",
7004/lov/CloseCreditMethodVO",
"name": "CloseCreditMethodVO",
},
{
"rel": "lov",
7004/lov/SalesProductTypeLookupVA",
"name": "SalesProductTypeLookupVA",
},
{
"rel": "lov",
22 | P a g e
7004/lov/ShipToPartySiteVA",
"name": "ShipToPartySiteVA",
},
{
"rel": "child",
7004/child/billLines",
"name": "billLines",
},
{
"rel": "child",
7004/child/charges",
"name": "charges",
},
{
"rel": "child",
7004/child/coveredLevels",
"name": "coveredLevels",
},
{
"rel": "child",
7004/child/creditCards",
"name": "creditCards",
},
{
"rel": "child",
7004/child/relationships",
"name": "relationships",
},
{
"rel": "child",
7004/child/salesCredits",
"name": "salesCredits",
},
{
"rel": "action",
23 | P a g e
7004/action/putOnHold",
"name": "putOnHold",
"kind": "other"
},
{
"rel": "action",
7004/action/removeHold",
"name": "removeHold",
"kind": "other"
},
{
"rel": "action",
7004/action/cancel",
"name": "cancel",
"kind": "other"
},
{
"rel": "action",
7004/action/close",
"name": "close",
"kind": "other"
},
{
"rel": "action",
7004/action/suspend",
"name": "suspend",
"kind": "other"
},
{
"rel": "action",
7004/action/resume",
"name": "resume",
"kind": "other"
}
]
}
],
"links": [
{
"rel": "self",
"href": "https://faehyp88.fa.dc1.c9dev2.oraclecorp.com:443/crmRestApi/r
esources/11.13.18.05/subscriptions/GP-3333",
"kind": "item",
"properties": {
24 | P a g e
"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6
973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A61
76612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106
A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
}
},
{
"rel": "canonical",
esources/11.13.18.05/subscriptions/GP-3333",
"kind": "item"
},
{
"rel": "lov",
esources/11.13.18.05/subscriptions/GP-3333/lov/ConversionRateTypeVA",
"name": "ConversionRateTypeVA",
},
{
"rel": "lov",
esources/11.13.18.05/subscriptions/GP-3333/lov/CancelReasonVA",
"name": "CancelReasonVA",
},
{
"rel": "lov",
esources/11.13.18.05/subscriptions/GP-3333/lov/PriceAdjustmentTypeVA",
"name": "PriceAdjustmentTypeVA",
},
{
"rel": "lov",
esources/11.13.18.05/subscriptions/GP-3333/lov/PaymentTermsVA",
"name": "PaymentTermsVA",
},
{
"rel": "lov",
esources/11.13.18.05/subscriptions/GP-3333/lov/CurrencyVA",
"name": "CurrencyVA",
},
{
"rel": "lov",
esources/11.13.18.05/subscriptions/GP-3333/lov/PeriodVA",
"name": "PeriodVA",
},
{
"rel": "lov",
25 | P a g e
esources/11.13.18.05/subscriptions/GP-3333/lov/CommunicationChannelVA",
"name": "CommunicationChannelVA",
},
{
"rel": "lov",
esources/11.13.18.05/subscriptions/GP-3333/lov/StatusVA",
"name": "StatusVA",
},
{
"rel": "lov",
esources/11.13.18.05/subscriptions/GP-3333/lov/InternalApprovalVA",
"name": "InternalApprovalVA",
},
{
"rel": "lov",
esources/11.13.18.05/subscriptions/GP-3333/lov/RenewalTypeVA",
"name": "RenewalTypeVA",
},
{
"rel": "lov",
esources/11.13.18.05/subscriptions/GP-3333/lov/LanguageVA",
"name": "LanguageVA",
},
{
"rel": "lov",
esources/11.13.18.05/subscriptions/GP-3333/lov/LayoutTemplateVA",
"name": "LayoutTemplateVA",
},
{
"rel": "lov",
esources/11.13.18.05/subscriptions/GP-3333/lov/BillServiceVA",
"name": "BillServiceVA",
},
{
"rel": "lov",
esources/11.13.18.05/subscriptions/GP-3333/lov/BusinessUnitVA",
"name": "BusinessUnitVA",
},
{
"rel": "lov",
26 | P a g e
esources/11.13.18.05/subscriptions/GP-3333/lov/ShipToPartySiteVA",
"name": "ShipToPartySiteVA",
},
{
"rel": "lov",
esources/11.13.18.05/subscriptions/GP-3333/lov/PriceAdjustmentBasisVA",
"name": "PriceAdjustmentBasisVA",
},
{
"rel": "lov",
esources/11.13.18.05/subscriptions/GP-3333/lov/BillingDateCodeVA",
"name": "BillingDateCodeVA",
},
{
"rel": "lov",
esources/11.13.18.05/subscriptions/GP-3333/lov/AccountingRuleVA",
"name": "AccountingRuleVA",
},
{
"rel": "lov",
esources/11.13.18.05/subscriptions/GP-3333/lov/SubscriptionsPaymentMethodVA",
"name": "SubscriptionsPaymentMethodVA",
},
{
"rel": "lov",
esources/11.13.18.05/subscriptions/GP-3333/lov/CustomerAcceptanceVA",
"name": "CustomerAcceptanceVA",
},
{
"rel": "lov",
esources/11.13.18.05/subscriptions/GP-3333/lov/ShipToPartyVA",
"name": "ShipToPartyVA",
},
{
"rel": "lov",
esources/11.13.18.05/subscriptions/GP-3333/lov/UserPVA",
"name": "UserPVA",
},
{
"rel": "lov",
27 | P a g e
esources/11.13.18.05/subscriptions/GP-3333/lov/TaxExemptionControlVA",
"name": "TaxExemptionControlVA",
},
{
"rel": "lov",
esources/11.13.18.05/subscriptions/GP-3333/lov/DefinitionOrgVA",
"name": "DefinitionOrgVA",
},
{
"rel": "lov",
esources/11.13.18.05/subscriptions/GP-3333/lov/LegalEntityAllVA",
"name": "LegalEntityAllVA",
},
{
"rel": "lov",
esources/11.13.18.05/subscriptions/GP-3333/lov/BillToAccountVA",
"name": "BillToAccountVA",
},
{
"rel": "lov",
esources/11.13.18.05/subscriptions/GP-3333/lov/CloseReasonVA",
"name": "CloseReasonVA",
},
{
"rel": "lov",
esources/11.13.18.05/subscriptions/GP-3333/lov/OutputTaxClassificationVA",
"name": "OutputTaxClassificationVA",
},
{
"rel": "lov",
esources/11.13.18.05/subscriptions/GP-3333/lov/BillingDayLOVVO",
"name": "BillingDayLOVVO",
},
{
"rel": "lov",
esources/11.13.18.05/subscriptions/GP-3333/lov/ExemptCertificateVA",
"name": "ExemptCertificateVA",
},
{
"rel": "lov",
28 | P a g e
esources/11.13.18.05/subscriptions/GP-3333/lov/InvoiceRuleVA",
"name": "InvoiceRuleVA",
},
{
"rel": "lov",
esources/11.13.18.05/subscriptions/GP-3333/lov/DocFiscalClassificationVA",
"name": "DocFiscalClassificationVA",
},
{
"rel": "lov",
esources/11.13.18.05/subscriptions/GP-3333/lov/SubscriptionProfileVA",
"name": "SubscriptionProfileVA",
},
{
"rel": "lov",
esources/11.13.18.05/subscriptions/GP-3333/lov/PrimaryPartyVA",
"name": "PrimaryPartyVA",
},
{
"rel": "lov",
esources/11.13.18.05/subscriptions/GP-3333/lov/BillingFrequencyVA",
"name": "BillingFrequencyVA",
},
{
"rel": "child",
esources/11.13.18.05/subscriptions/GP-3333/child/contractAttachment",
"name": "contractAttachment",
},
{
"rel": "child",
esources/11.13.18.05/subscriptions/GP-3333/child/parties",
"name": "parties",
},
{
"rel": "child",
esources/11.13.18.05/subscriptions/GP-3333/child/products",
"name": "products",
},
{
"rel": "child",
29 | P a g e
esources/11.13.18.05/subscriptions/GP-3333/child/salesCredits",
"name": "salesCredits",
},
{
"rel": "child",
esources/11.13.18.05/subscriptions/GP-
3333/child/supportingDocumentAttachments",
"name": "supportingDocumentAttachments",
},
{
"rel": "child",
esources/11.13.18.05/subscriptions/GP-3333/child/validateSubscription",
"name": "validateSubscription",
},
{
"rel": "action",
esources/11.13.18.05/subscriptions/GP-3333/action/previewSubscriptions",
"name": "previewSubscriptions",
"kind": "other"
},
{
"rel": "action",
esources/11.13.18.05/subscriptions/GP-3333/action/putOnHold",
"name": "putOnHold",
"kind": "other"
},
{
"rel": "action",
esources/11.13.18.05/subscriptions/GP-3333/action/removeHold",
"name": "removeHold",
"kind": "other"
},
{
"rel": "action",
esources/11.13.18.05/subscriptions/GP-3333/action/activate",
"name": "activate",
"kind": "other"
},
{
"rel": "action",
esources/11.13.18.05/subscriptions/GP-3333/action/cancel",
"name": "cancel",
"kind": "other"
},
{
"rel": "action",
30 | P a g e
esources/11.13.18.05/subscriptions/GP-3333/action/close",
"name": "close",
"kind": "other"
},
{
"rel": "action",
esources/11.13.18.05/subscriptions/GP-3333/action/renew",
"name": "renew",
"kind": "other"
},
{
"rel": "action",
esources/11.13.18.05/subscriptions/GP-3333/action/raiseUserTransition",
"name": "raiseUserTransition",
"kind": "other"
}
]
}
Update a Subscription
Method: PATCH
URI: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionPUID}
Example:
https://zcmw.fa.dc1.c9dev2.oraclecorp.com:443/crmRestApi/resources/11.13.18.05/subscriptions/GP-
5678
Request Body:
{
"EndDate": "2019-12-25"
}
Response Body:
{
31 | P a g e
"PricedOnDate": "2019-06-04T00:00:00+00:00",
"Currency": "USD",
"StartDate": "2019-01-01",
"Duration": 359,
"Period": "DY",
"EndDate": "2019-12-25",
"ClosedDate": null,
"UserStatus": null,
"BillOnDay": null,
32 | P a g e
"ShipToSite": null,
"PONumber": null,
"WireNumber": null,
"AssigneeId": null,
"SourceKey": null,
33 | P a g e
"CreationDate": "2019-06-04T04:25:03+00:00",
"LastUpdateDate": "2019-06-04T04:29:14+00:00",
...
}
Delete a Subscription
Method: DELETE
Example:
5678
Response Body:
Blank
Status: 204 No Content
Get a Subscription
Method: GET
Example:
5678
Response Body:
34 | P a g e
{
"PricedOnDate": "2019-06-04T00:00:00+00:00",
"Currency": "USD",
"StartDate": "2019-01-01",
"Duration": 359,
"Period": "DY",
"EndDate": "2019-12-25",
"ClosedDate": null,
"UserStatus": null,
"BillOnDay": null,
35 | P a g e
"ShipToSite": null,
"PONumber": null,
"WireNumber": null,
"AssigneeId": null,
"SourceKey": null,
36 | P a g e
"CreationDate": "2019-06-04T04:25:03+00:00",
...
}
Get Subscriptions
Method: GET
URI: /crmRestApi/resources/11.13.18.05/subscriptions
Example:
https://zcmw.fa.dc1.c9dev2.oraclecorp.com:443/crmRestApi/resources/11.13.18.05/subscriptions
Response Body:
{
"items": [
{
"SubscriptionNumber": "CDRM_2",
"SubscriptionProfileName":
"zOSS_SP_ServiceStartActual_Advance_Month",
"PrimaryPartyName": "Computer Service and Rentals",
"PricedOnDate": "2019-06-03T00:00:00+00:00",
37 | P a g e
"Currency": "USD",
"StartDate": "2019-06-03",
"Duration": 1,
"Period": "0zE",
"EndDate": "2020-06-02",
"ClosedDate": null,
"UserStatus": null,
"BillOnDay": null,
"SubscriptionInvoiceText": "[$Item Name]: [$Charge Name] [$Bill
from Date]-[$Bill to Date]",
"BillToAccountDescription": "Computer Service and Rentals",
"BillToAddress": "301 Summit Hill Drive,CHATTANOOGA, TN 37401",
"ShipToSite": null,
"PONumber": null,
"WireNumber": null,
38 | P a g e
"InternalApproval": "NOTREQUIRED",
"AssigneeId": null,
"TotalContractValue": 0,
"EstimatedTax": 0,
"CreditedAmount": 0,
"ClosedAmount": 0,
"CanceledAmount": 0,
"InvoicedAmount": 0,
"SourceKey": null,
"CreationDate": "2019-06-03T16:38:37+00:00",
"LastUpdateLogin": "8A568A6CC2BCBE27E05323EAF40A845E",
...
"count": 5,
39 | P a g e
"hasMore": false,
"limit": 25,
"offset": 0,
"links": [
{
"rel": "self",
"href":
"https://zcmw.fa.dc1.c9dev2.oraclecorp.com:443/crmRestApi/resources/11.13.18.
05/subscriptions",
}
]
}
Activate a Subscription (Custom)
Method: POST
Media Type: application/vnd.oracle.adf.action+json
Example:
https://zcmw.fa.dc1.c9dev2.oraclecorp.com:443/crmRestApi/resources/11.13.18.05/subscriptions/CDR
M_4
Request Body:
{
"name":"activate"
}
Response Body:
{
"result": "Success"
}
Preview a Subscription (Custom)
Method: POST
40 | P a g e
Example:
5678
Request Body:
{
"name" : "previewSubscriptions",
"parameters":[
]
}
Response Body:
{
"result": "GP-
5678.pdf,application/pdf,JVBERi0xLjYNCjUgMCBvYmoNCjw8DQovVHlwZSAvWE9iamVjdA0K
L1N1YnR5cGUgL0ltYWdlDQov\nRmlsdGVyIC9EQ1REZWNvZGUNCi9MZW5ndGggMjc4OA0KL1dpZHR
oIDE2OA0KL0hlaWdodCAxMTcN\nCi9CaXRzUGVyQ29tcG9uZW50IDgNCi9Db2xvclNwYWNlIC9EZX
ZpY2VSR0INCj4+DQpzdHJlYW0N\nCv/Y/+AAEEpGSUYAAQEAAAEAAQAA/9sAQwAQCwwODAoQDg0OE
hEQExgoGhgWFhgxIyUdKDozPTw5\nMzg3QEhcTkBEV0U3OFBtUVdfYmdoZz5NcXlwZHhcZWdj/9sA
QwEREhIYFRgvGhovY0I4QmNjY2Nj\nY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2N
jY2NjY2NjY2Nj/8AAEQgAdQCoAwEi\nAAIRAQMRAf/EAB8AAAEFAQEBAQEBAAAAAAAAAAABAgMEBQ
YHCAkKC//EALUQAAIBAwMCBAMFBQQE\nAAABfQECAwAEEQUSITFBBhNRYQcicRQygZGhCCNCscEVU
tHwJDNicoIJChYXGBkaJSYnKCkqNDU2\nNzg5OkNERUZHSElKU1RVVldYWVpjZGVmZ2hpanN0dXZ3
eHl6g4SFhoeIiYqSk5SVlpeYmZqio6Sl\npqeoqaqys7S1tre4ubrCw8TFxsfIycrS09TV1tfY2dr
h4uPk5ebn6Onq8fLz9PX29/j5+v/EAB8B\nAAMBAQEBAQEBAQEAAAAAAAABAgMEBQYHCAkKC//EAL
URAAIBAgQEAwQHBQQEAAECdwABAgMRBAUh\nMQYSQVEHYXETIjKBCBRCkaGxwQkjM1LwFWJy0QoWJ
DThJfEXGBkaJicoKSo1Njc4OTpDREVGR0hJ\nSlNUVVZXWFlaY2RlZmdoaWpzdHV2d3h5eoKDhIWG
h4iJipKTlJWWl5iZmqKjpKWmp6ipqrKztLW2\nt7i5usLDxMXGx8jJytLT1NXW19jZ2uLj5OXm5+j
p6vLz9PX29/j5+v/aAAwDAQACEQMRAD8A6W78\nSW1hqstneRvGihSsw5HI7jt+ta1vcQ3MQlt5Ul
jPRkbIrzvxnubxHMoyflTA/wCAiq3hu4ng1u0S\nOV0WSVVdVbAYZ6EV1ewTgpIjm1sepUVyyeMYo
NUubS/i2RxzMiypzwCRyP8ACujtrmC7hWa3lSWN\nujKc1hKEo7lJpk1FFFQMKKKKACiiigAooooA
KKKKACiiigAooooAKKKKACiiigDzbxozf8JDOuTt\n2px/wEVR0D/kPWP/AF2X+dXPGn/Ixz/7qf8
AoIqnoH/Iesf+uy/zr0o/w/kYvcbrRX+2r8BST9ok\n6n/aNdV8P0ZYL0suNzJj9a5XWHZdbv8Aac
H7TJ/6Ea6r4fbvIvS2eWTBPfg1FX+EOPxHX0UUVwGo\nUUUUAFFFFABRRRQAUUUUAFFFFABRRRQAU
UUUAFFFFAHmvjMZ8ST4/up/6CKqaAoGuWJLDPnLwOe9\ndjrXheDVdQe5N6YpXAG3aCBgY9RVKx8G
z2Wp21wt3FJHFIGIKFSQD+Nd0asOS1+hm4u5y+sOU1y/\nIAz9pk5x/tGuq+H7s8N7uYnDJj8jWbq
3hfVJNRu7mO3WWOSZ3UK4zgknpxW14Ksruyiu1u7doSWX\nbuXGeD+dKpKLp6MEnc6eiiiuI0Ciii
gAooooAKKKKACiiigAooooAKKKKACiiigAooooA5nXf+Qi\nf90VX05j9vg5P3xVnXQP7RPP8Iqtp
+P7Qt8f3xXSvhES3V3cR3s6xzSgCRuN59fStTRJ7icTfaJC\n+Nu3PbrWJeki+uMf89W/ma1fDikC
4JGM7f61MkuUDbqvftMthcNbsFmWNihIyN2OOKsUh5GDWAzy\nj/hP9d/56Qf9+hXqyZ2LlgxwMkd
68HvIfs17PB/zykZPyOK9fTWorLwjb6pOc4tkbbn7zlR8v50A\nZnijxBf22tWelaMUa5kH7xWXcB
nG36cZJ9qh1vU/FVpfC3sLV54441DzC3yHfGSR7c4/Cm+B9Pkl\na58R6lzNcFjGW/hXu39B7D3rg
rnUru4u5ZI7idRJIWVQ54yelAHrvhqbU7jShNq6eXcs7fJs2lV6\nDI/M/jWtXm/jTU7vS4NO0e2u
pIzFbq0zIxDM3Tk/gT+Nc7Y3UMqO2oatfxPngRrvyPUksKAPaq57\nxZqGs2aWy6LavM7ljIwi3hQ
MYH45/SuO0axstV1COC18RXqy/eEc0RG/HJAO/wBKr+NtSmfxRdrb\nzyIke1MK5AyAM/rQB2vhO8
1+8luTrUBhjRVEYMWwsTnP5Y/WulrzlNSu9E+H8M8c7i7vpjtdjllX\nkZGfZR/31WR4bs9S8SX7W
7ancxJEhdnLs+OQMAZ7/wBKAPXaK8h8TWd14e1KO2i1a4nZoxJnJUrk\nkY6n0rotE1q6b4f6lcXs
rSGHfDFIx+Y5UAZPfBagDvKK8T0h9R1DVbW1hvJ1eSQAMXJ29ycZ5wOa\n1vFumXXh97Y/2zc3Mk+
4ncSpGMc9T6/pQB6tRXE/DfU729gvILqV5o4SpR3JJG7ORk/SigDS1xCd\nQJ4A2jkmq2nhRfwfMS
d46CrOuIzaixA42jmq2nqBfwZYE7xwK6F8Iht6SL64x/z1b+ZrU8OEn7Tk\n5+7/AFrMukd9QuBGh
41 | P a g e
c+a3QZ7mtjQoJ4RMZo2QNt25/GlP4QNaiiisBni/i2D7P4o1FMYzKX/AO+v\nm/rV/S2uvE40vQhu
S2tAzzMD1G48/kQB7mvSrrRdMvJ2nubC3mlbGXdASccVJZaZY6eXNlaQwF8b\njGgGcUAZviq4j0r
wpdCICMeV5ESjjGflwPoP5V5l4Ws/t3iSwgIyvmh2HsvzH+Vew3ljaX8ax3lv\nHOincFkXIB9aht
dF0yznWe1sLeGVc4dEAIzxQBw/i0eH9W1Rpv7Z+y3MeYpUa3dwSpI6gVzGoWWm\n20Aez1dbyQtgx
i3dMD1ya9bfw9o8js76ZaszHJJjGSaT/hG9F/6Bdp/36FAHm/gODdr/ANsk4gso\nnmkbsPlI/rn8
KwriWS+vpZiMyTyFsepY5/rXt0el2EVo9rFZwJBJ9+NUADfX1quvh3RkYMumWoYH\nIIjHFAHBfEF
Gs20rTlH7m2tQFPYnof8A0EfnUngLWdJ0a3vGv7nyZpWUAeWzfKAfQHuTXod5YWl+\ngS8top1U5A
kQNj6VU/4RvRf+gXaf9+hQB5P4l1JdW166u4yTEzbY8jHygYH8s/jW5robSfA2l6aw\n2TXTmeVe+
OuD+a/lXfRaBpEMiyR6baq6nIIiHFTXmlaffyLJeWcM7qNoaRASB6UAed/DSyE+uTXT\nYxbRcf7z
cfy3VW+IN79r8SyRK2UtkWIY9ep/U4/CvTrLTLHTy5srSGAvgMY1Aziq8nh/R5ZGkk02\n2Z3JZmM
YJJPegDI+HNn9n8Nicj5rmVnz7D5R/I/nRXS21vDaQLBbxLFEn3UUYA70UAVrrS4bq482\nV36Y2g
4FSwWFrbkGOFQw7nk/rVmind7AIBjpS0UUgCikYhQSTgCoftSejflRYTaW5PRUH2pPRvyo\n+1J6N
+VOzFzInoqAXSE42t+VSM4U4NFh3Q+io/NHoaPNHoaVguiSio/NHoaf2oC9xaKKKBhRRRQA\nUUUU
AFFFFABRRRQAUUlVLibf8qn5e/vTSuTKVh84lkOFU7R+tQ+RL/cNR0VdjFtPUk8iX+4aPIl/\nuGo
6KBaFiGBhIC64A5qV1JYnj86I18qH370yp3NbWVhdh9vzo2H2/OkooELsPt+dTjpVerNJlxCi\nii
kUFFFFABRRRQAUUUUAFFFFACEAjB5FN8qP+4v5UUUBYPKj/uL+VJ5Uf9wflRRRcVkHkx/3BQIY\nw
chBRRRcLIeQD1FJsX0FFFAw2L6CjYvoKKKAsGxfQU6iigAooooAKKKKACiiigAooooA/9kNCmVu\n
ZHN0cmVhbQ0KZW5kb2JqDQo2IDAgb2JqDQo8PA0KL1R5cGUgL1BhZ2UNCi9QYXJlbnQgMyAwIFIN\
nCi9SZXNvdXJjZXMgNCAwIFINCi9Db250ZW50cyA3IDAgUg0KL01lZGlhQm94WyAwIDAgNjEyLjAg
\nNzkyLjAgXQ0KL0Nyb3BCb3hbIDAgMCA2MTIuMCA3OTIuMCBdDQovUm90YXRlIDANCj4+DQplbmR
v\nYmoNCjcgMCBvYmoNCjw8IC9MZW5ndGggNjU1IC9GaWx0ZXIgL0ZsYXRlRGVjb2RlID4+DQpzdH
Jl\nYW0NCnic7VXbbtpAEH1H4h/mqaIPDHu/5C3NTVQVueD2nRCTUtU4sUm/p5/aWRsnXhvSSJWqP
lQG\nDDtzZs6Zs14eh4PH4YDBR+DwbTjgwOjiYAUysNrQ5zKjZbqz3Tt8H1dxeSisPDoYS6Wb+K5q
DRu/\n1I2bV78mF3MO9yUto7NOSa6kl95b7gW8bam4f4Og3bKgFQFjzat1CF0tsxStb+P4Z6Mx0lS
XeKnw\nutgPyR8qGw7QObfrwY1DKTUY61EwDQm1mZzz4QA4E5CshoPR6c3xefLzfUKzOKPe163XP2
e8+G/8\nXzE+eA/WoDNVOUGuUS0rwHKN3OigZzLNGJzmcB1mGq6bC6i/BDJBTaNXeY3eumdwzUUEL
rymcnE1\n1sa6isuzAcajFA6MIyWkq0bJgNoJmD/dlsti/bBd55sYKhUaA0ZJ1MJWyCgZpptVXmSL
HpAUGsHQ\nSN5q537TjQuJPAaOZk/ZbVocxXnaoZBNomiNwR2eQmDEqD4XfUZnq1W63K5/pHEbZlE
bF8FGp4tt\nWnbo0JCE6lRvseETunwMMQy96JTe5nFO2Nyqk8PFROhuNZKmHR0Efo+02SJLY7reoe
khWnS/rMu+\nMQJpEG3I6PIhLSrfyx4X7ZHZPVxOnsptnvXc5DQ+ml8MaxE67nDhSA9tlD5KOikOn
TdxyruOZwaV\nNq9WCZs+qG6nzC8/fU6ml7N5nOrJqo6E0XR20puMlMj0nskc390VadnZVwFAD7pu
HoWTfLNdLLe9\nJEWOsmaDXH3NN2k/xTFUjXNn2WL9/ej5uNL0H8I1KOvCLkZNG88inYhQpEDcjEH
5xqiiI1KGnHbM\nkBmHQoyFg3FvTFtFR6U/ANRE2R0AKjJfdGO/ANVK4Z8NCmVuZHN0cmVhbQ0KZW
5kb2JqDQoxMyAw\nIG9iag0KPDwNCi9UeXBlIC9QYWdlDQovUGFyZW50IDMgMCBSDQovUmVzb3VyY
2VzIDQgMCBSDQov\nQ29udGVudHMgMTQgMCBSDQovTWVkaWFCb3hbIDAgMCA2MTIuMCA3OTIuMCBd
DQovQ3JvcEJveFsg\nMCAwIDYxMi4wIDc5Mi4wIF0NCi9Sb3RhdGUgMA0KPj4NCmVuZG9iag0KMTQ
gMCBvYmoNCjw8IC9M\nZW5ndGggOTg3IC9GaWx0ZXIgL0ZsYXRlRGVjb2RlID4+DQpzdHJlYW0NCn
ic7VbJbhtHEL0T4D/U\nkQbMYi/VW26KJQtJvMmkbwYMWp7INCzRIUcykq/Jp6Z6ZiR298wwAgIEO
QRcp+tVVdf2ugUIfr09\nn05E8293NZ38uJpOFs81eFj9Op2c8dNvzVvAzyDhy3QiG6gEp1CAM5a/
L695mX9F94n/541cj4kp\noIe5JnMv76y2avOD3dx587Q4X2q42vMyeudJS9JBh+BkUPC4pRjo3wb
ULSteUTA3slmH6NUJx9L2\nZ54/3seYxdSaOFg4HmyswD+KbDpB733nQ1qPWhuwLqASBlbXsb5yOg
EpVFPj2enbk+erP5+svrT1\nvkje/7nC0/+F/1cKH2sPzqK3jTnFVWNbToGTBqU1MZ7FT9cCTrdw0
W79PjgKBoPzD8jWsYqOZev3\n/M3cWOcbx4cigOXeMNp1CjoqdBtd3n7cX+423+rN9mafqZmABFY5
NJme6AKsHtQyLSUU+kxvdnG7\nvqk39e85zhDXL4W9e/0yQ2jSyFtOIct6vavhdF1XGZKkQGUz5Nn
Npz7OaI+kM9xqW6+/AryfvVue\nvn8yEL/UGDieQ6Zb9p69WsfQWfe82l7t1t8+by4hzWUeLDsORm
XWZnIoHyngbJ3nI3adLWws+BXy\nZCiFZKnAqYUyJdJYQiMLpH0qSGKgh9ZV5NEYMJ69ewloIs/wa
MCuAk6E0ejGpTIIDKNSze18RFkr\nj2pcTMYf07aCR/mR2zbkYowMSqVWO1R+TKgkUl+YTqviihvm
IenTAQr9uYOmC38A7kHIS84hCh7t\n1EpeoWTGjebJE35gxp9t76rd+iofBqmZU3Ot2bLa3W0uq33
PtGhz16eBYdNKIFNaqjV7sbkpQMQN\nT7awnUzYsGkvURamv2/qzzkocFGCz1Ev35z0x5u4AUjIfn
ka59WnTIOtBpmpzF5Ud9XXIiyPBYiz\nulkXKMcELm2Oe3V7/bHaFcTBExIK3DCfel36LQmVOB0u6
GJzI5TqJGPzBI2QquN5iJ4dc6scaJGm\nuQviiWce+zB8KHW2RxmYrEG+0/T744/Xvzz7cHJbbz+c
7PdVXdCpdeh5/lLtknHbjKWAgnEpjogt\nbAwwLl8DrKUCN8y4fDmRpUX1VFuJKhwo13EumbA014t
UJBfD0XBDpwQ0JtWBjirz1SGMiy0f30eM\nS1LHjJM5unGl9CPi4jGTFDmZrywl696rDgtdvHr0ND
NK5jscdylfoijpVJ/NPDRDvR8n5cA5YFJM\n7RRFTKiT4uHqdL99oUTGwrmuJ6BgAYc2lfepinkSI
sUeOUoE8pmVeeHuFr1d8M2U+Joxst/Ynn8B\nSZIAmg0KZW5kc3RyZWFtDQplbmRvYmoNCjEgMCBv
YmoNCjw8DQovVHlwZSAvQ2F0YWxvZw0KL1Bh\nZ2VzIDMgMCBSDQo+Pg0KZW5kb2JqDQoyIDAgb2J
qDQo8PA0KL1R5cGUgL0luZm8NCi9Qcm9kdWNl\nciAoT3JhY2xlIEJJIFB1Ymxpc2hlcikNCj4+DQ
42 | P a g e
plbmRvYmoNCjMgMCBvYmoNCjw8DQovVHlwZSAv\nUGFnZXMNCi9LaWRzIFsNCjYgMCBSDQoxMyAwI
FINCl0NCi9Db3VudCAyDQo+Pg0KZW5kb2JqDQo0\nIDAgb2JqDQo8PA0KL1Byb2NTZXQgWyAvUERG
IC9UZXh0IF0NCi9Gb250IDw8IA0KL0YxIDkgMCBS\nDQovRjIgMTEgMCBSDQovRjMgMTIgMCBSDQo
+Pg0KL0V4dEdTdGF0ZSA8PA0KL0dTMSA4IDAgIFIN\nCi9HUzIgMTAgMCAgUg0KL0dTMyAxNSAwIC
BSDQovR1M0IDE2IDAgIFINCj4+DQovWE9iamVjdCA8\nPCANCi9JbTAgNSAwIFINCj4+DQo+Pg0KZ
W5kb2JqDQo4IDAgb2JqDQo8PA0KL1R5cGUgL0V4dEdT\ndGF0ZQ0KL0JNIC9Ob3JtYWwNCi9DQSAw
LjUNCi9jYSAwLjUNCj4+DQplbmRvYmoNCjkgMCBvYmoN\nCjw8DQovVHlwZSAvRm9udA0KL1N1YnR
5cGUgL1R5cGUxDQovQmFzZUZvbnQgL1RpbWVzLVJvbWFu\nDQovRW5jb2RpbmcgL1dpbkFuc2lFbm
NvZGluZw0KPj4NCmVuZG9iag0KMTAgMCBvYmoNCjw8DQov\nVHlwZSAvRXh0R1N0YXRlDQovQk0gL
05vcm1hbA0KL0NBIDAuNQ0KL2NhIDAuNQ0KPj4NCmVuZG9i\nag0KMTEgMCBvYmoNCjw8DQovVHlw
ZSAvRm9udA0KL1N1YnR5cGUgL1R5cGUxDQovQmFzZUZvbnQg\nL0hlbHZldGljYQ0KL0VuY29kaW5
nIC9XaW5BbnNpRW5jb2RpbmcNCj4+DQplbmRvYmoNCjEyIDAg\nb2JqDQo8PA0KL1R5cGUgL0Zvbn
QNCi9TdWJ0eXBlIC9UeXBlMQ0KL0Jhc2VGb250IC9IZWx2ZXRp\nY2EtQm9sZA0KL0VuY29kaW5nI
C9XaW5BbnNpRW5jb2RpbmcNCj4+DQplbmRvYmoNCjE1IDAgb2Jq\nDQo8PA0KL1R5cGUgL0V4dEdT
dGF0ZQ0KL0JNIC9Ob3JtYWwNCi9DQSAwLjUNCi9jYSAwLjUNCj4+\nDQplbmRvYmoNCjE2IDAgb2J
qDQo8PA0KL1R5cGUgL0V4dEdTdGF0ZQ0KL0JNIC9Ob3JtYWwNCi9D\nQSAwLjUNCi9jYSAwLjUNCj
4+DQplbmRvYmoNCjE3IDAgb2JqDQpbIDEzIDAgUiAvWFlaIDY2LjYg\nMzQ1LjAwMiBudWxsIF0NC
mVuZG9iag0KMTggMCBvYmoNClsgMTMgMCBSIC9YWVogNjYuNiAzNDUu\nMDAyIG51bGwgXQ0KZW5k
b2JqDQp4cmVmDQowIDE5DQowMDAwMDAwMDAwIDY1NTM1IGYNCjAwMDAw\nMDUwOTggMDAwMDAgbg0
KMDAwMDAwNTE1MyAwMDAwMCBuDQowMDAwMDA1MjI0IDAwMDAwIG4NCjAw\nMDAwMDUzMDAgMDAwMD
Agbg0KMDAwMDAwMDAxMCAwMDAwMCBuDQowMDAwMDAyOTgxIDAwMDAwIG4N\nCjAwMDAwMDMxMzkgM
DAwMDAgbg0KMDAwMDAwNTUwNCAwMDAwMCBuDQowMDAwMDA1NTc4IDAwMDAw\nIG4NCjAwMDAwMDU2
ODUgMDAwMDAgbg0KMDAwMDAwNTc2MCAwMDAwMCBuDQowMDAwMDA1ODY2IDAw\nMDAwIG4NCjAwMDA
wMDM4NzIgMDAwMDAgbg0KMDAwMDAwNDAzMiAwMDAwMCBuDQowMDAwMDA1OTc3\nIDAwMDAwIG4NCj
AwMDAwMDYwNTIgMDAwMDAgbg0KMDAwMDAwNjEyNyAwMDAwMCBuDQowMDAwMDA2\nMTgwIDAwMDAwI
G4NCnRyYWlsZXINCjw8DQovU2l6ZSAxOQ0KL1Jvb3QgMSAwIFINCi9JbmZvIDIg\nMCBSDQovSUQg
Wzw5ZGNmYThiMGQzZjNhZjY2MGUxMWZhNzQ5YjI0NjEzNj48OWRjZmE4YjBkM2Yz\nYWY2NjBlMTF
mYTc0OWIyNDYxMzY+XQ0KPj4NCnN0YXJ0eHJlZg0KNjIzMw0KJSVFT0YNCg=="
}
Renew a Subscription (Custom)
Method: POST
URI: /crmRestApi/resources/latest/subscriptions/{SubscriptionPUID}
Example:
https://zcmw.fa.dc1.c9dev2.oraclecorp.com:443/crmRestApi/resources/latest/subscriptions/GP-6789
Request Body:
{
"name": "renew",
"parameters": [
{
"duration": 1
},
{
"period": "0zG"
43 | P a g e
},
{
"ignoreWarning": "Y"
}
]
}
Response Body:
{
"result": "CDRM_14"
}
Cancel a Subscription (Custom)
Method: POST
Example:
https://zcmw.fa.dc1.c9dev2.oraclecorp.com:443/crmRestApi/resources/latest/subscriptions/CDRM_2
Request Body:
{
"name":"cancel",
"parameters":[
{
"cancelReason":"ORA_PRICING"
},
{
"canceledDate":"2019-06-03"
}
]
}
Response Body:
{
"result": "Success"
}
Close a Subscription (Custom)
Method: POST
44 | P a g e
Example:
Request Body:
{
"name":"close",
"parameters":[
{
"closedDate":"2019-06-02"
},
{
"closeReason":"ORA_NON_COMPLIANCE"
},
{
"closeCreditMethod":"ORA_FULL"
}
]
}
Response Body:
{
"result": "Success"
}
Hold a Subscription (Custom)
Method: POST
Example:
Request Body:
{
"name": "putOnHold"
}
Response Body:
45 | P a g e
{
"result": "Success"
}
Remove Hold on a Subscription (Custom)
Method: POST
Example:
Request Body:
{
"name": "removeHold"
}
Response Body:
{
"result": "Success"
}
Subscription Parties
Create a Subscription Party
Method: POST
URI: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionPUID}/child/parties
Example:
5678/child/parties
Request Body:
46 | P a g e
{
"PartyPuid": "GP-5678-PRTY-24",
"PartyRole": "ORA_CUSTOMER",
"PartyId": 300100070252912,
"PrimaryFlag": false,
"InternalFlag": false
}
Response Body:
{
"SubscriptionPartyId": 300100177241440,
"PartyId": 300100070252912,
"InternalFlag": false,
"CreationDate": "2019-06-04T18:39:36+00:00",
"LastUpdateLogin": "8A5689AE12D939D9E05322EAF40A63A4",
"PartyName": " Clarke James",
"PartyNumber": "CDRM_154814",
...
}
Delete a Subscription Party
Method: DELETE
URI: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionPUID}/child/parties/{PartyPUID}
Example:
https://zcmw.fa.dc1.c9dev2.oraclecorp.com:443/crmRestApi/resources/latest/subscriptions/GP-
5678/child/parties/GP-5678-PRTY-20
Response Body:
Blank
47 | P a g e
Get a Subscription Party
Method: GET
URI: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionPUID}/child/parties/{PartyPUID}
Example:
5678/child/parties/GP-5678-PRTY-9
Response Body:
{
"PartyId": 1001,
"PrimaryFlag": true,
"CreationDate": "2019-06-04T04:25:08.026+00:00",
"PartyName": "A T & T SOLUTIONS INC",
"PartyNumber": "1001",
...
}
Get Subscription Parties
Method: GET
URI: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionPUID}/child/parties
Example:
5678/child/parties
Response Body:
48 | P a g e
{
"items": [
{
"PartyId": 1001,
"PrimaryFlag": true,
"CreationDate": "2019-06-04T04:25:08.026+00:00",
"PartyName": "A T & T SOLUTIONS INC",
"PartyNumber": "1001",
...
},
{
"PartyRole": "ORA_VENDOR",
"PartyId": 204,
"InternalFlag": true,
"CreationDate": "2019-06-04T04:25:08.037+00:00",
"PartyName": null,
"PartyNumber": null,
...
}
],
"count": 2,
"hasMore": false,
"limit": 25,
"offset": 0,
...
}
Subscription Party Contacts

Create a Subscription Party Contact
Method: POST
49 | P a g e
URI:
/crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionPUID}/child/parties/{PartyPUID}/child/c
ontacts
Example:
5678/child/parties/GP-5678-PRTY-9/child/contacts
Request Body:
{
"ContactPuid": "GP-5678-PRTY-9-PCNT-10",
"ContactRole": "ORA_CUSTOMER_CONTACT",
"ContactId": 1009,
"BillingOwnerFlag": false,
}
Response Body:
{
"SubscriptionContactId": 300100177241556,
"PartyId": 1001,
"ContactId": 1009,
"StartDate": null,
"EndDate": null,
"AccessLevel": null,
"ContactName": "Mike Kenton",
"ContactEmail": null,
"CreationDate": "2019-06-05T03:14:40+00:00",
...
}
For creating a team member:
{
"ContactRole": "ORA_RESOURCE",
50 | P a g e
"ContactId": 6318,
}
Delete a Subscription Party Contact
Method: DELETE
URI:
ontacts/{ContactPUID}
Example:
5678/child/parties/GP-5678-PRTY-9/child/contacts/GP-5678-PRTY-9-PCNT-10
Response Body:
Blank
Get a Subscription Party Contact
Method: GET
URI:
ontacts/{ContactPUID}
Example:
5678/child/parties/GP-5678-PRTY-9/child/contacts/GP-5678-PRTY-9-PCNT-10
Response Body:
51 | P a g e
{
"PartyId": 1001,
"ContactId": 1009,
"StartDate": null,
"EndDate": null,
"CreationDate": "2019-06-04T18:24:30.391+00:00",
"LastUpdateLogin": "8A568A7FD0B9BE1EE05323EAF40A0287",
...
}
Get Subscription Party Contacts
Method: GET
URI:
ontacts
Example:
5678/child/parties/GP-5678-PRTY-9/child/contacts
Response Body:
{
"items": [
{
"PartyId": 1001,
"ContactId": 1009,
52 | P a g e
"StartDate": null,
"EndDate": null,
"CreationDate": "2019-06-04T18:24:30.391+00:00",
...
}
],
"count": 1,
"hasMore": false,
"limit": 25,
"offset": 0,
...
}
Subscription Sales Credits

Create a Subscription Sales Credit
Method: POST
URI: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionPUID}/child/salesCredits
Example:
5678/child/salesCredits
Request Body:
{
"SalesCreditPuid": "GP-5678-SLCR-1",
"SalesCreditTypeId": 1,
"SalesrepId": 100000008147775,
"Percentage": 100
}
Response Body:
53 | P a g e
"CreationDate": "2019-06-05T03:41:58+00:00",
"EndDate": null,
"Percentage": 100,
"SalesCreditId": 300100177254595,
"SalesrepId": 100000008147775,
"StartDate": null,
"SubscriptionProductId": null,
"SalesPerson": "Abhijit Chan",
"SalesCreditType": "Quota Sales Credit",
"QuotaFlag": true,
...
}
Update a Subscription Sales Credit
Method: PATCH
URI:
/crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionPUID}/child/salesCredits/{SalesCreditPU
ID}
Example:
5678/child/salesCredits/GP-5678-SLCR-9
Request Body:
{
"Percentage": 70
}
Response Body:
{
"CreationDate": "2019-06-05T04:16:57.173+00:00",
"EndDate": null,
54 | P a g e
"Percentage": 70,
"SalesCreditId": 300100177232435,
"SalesrepId": 100000000177813,
"StartDate": null,
"SalesPerson": "Aaron Wang",
"SalesCreditType": "Non-quota Sales Credit",
"QuotaFlag": false,
...
}
Delete a Subscription Sales Credit
Method: DELETE
URI:
ID}
Example:
Response Body:
Blank
Get a Subscription Sales Credit
Method: GET
URI:
ID}
Example:
55 | P a g e
Response Body:
{
"CreationDate": "2019-06-05T03:18:51+00:00",
"EndDate": null,
"LastUpdateLogin": "8A568ABC72F139D7E05322EAF40A0F90",
"Percentage": 50,
"SalesCreditId": 300100177232427,
"SalesrepId": 100000008147775,
"StartDate": null,
"QuotaFlag": true,
...
}
Get Subscription Sales Credits
Method: GET
URI: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionPUID}/child/salesCredits
Example:
5678/child/salesCredits
Response Body:
{
"items": [
{
"CreationDate": "2019-06-05T03:18:51+00:00",
"EndDate": null,
56 | P a g e
"Percentage": 50,
"SalesCreditId": 300100177232427,
"SalesrepId": 100000008147775,
"StartDate": null,
"QuotaFlag": true,
...
},
{
"CreationDate": "2019-06-05T03:19:10.228+00:00",
"EndDate": null,
"Percentage": 50,
"SalesCreditId": 300100177232428,
"SalesrepId": 100000008143794,
"StartDate": null,
"SalesPerson": "Alain Berthier",
"QuotaFlag": true,
...
}
],
"count": 2,
"hasMore": false,
"limit": 25,
"offset": 0,
...
}
Subscription Products
Create a Subscription Product
Method: POST
URI: /crmRestApi/resources/latest/subscriptions/{subscriptionPUID}/child/products/
57 | P a g e
Example:
5678/child/products/
Request Body:
{
"LineNumber": "1",
"Description": "QP Item for SPT Subscription",
"ProductName": "QP_Item3",
"Quantity": 1,
"StartDate": "2019-01-01",
"EndDate": "2019-12-25"
}
Response Body:
{
"LineNumber": "1",
"Quantity": 1,
"StartDate": "2019-01-01",
"EndDate": "2019-12-25",
"ClosedDate": null,
"UnitPrice": null,
"Currency": "USD",
"BillOnDay": null,
58 | P a g e

"InvoiceText": "[$Item Name]: [$Charge Name] [$Bill from Date]-[$Bill to
Date]",
"PONumber": null,
"WireNumber": null,
"TaxError": null,
"PriceAsOf": "2019-06-04",
"SourceKey": null,
"Duration": 359,
"Period": "DY",
59 | P a g e
"CreationDate": "2019-06-04T05:18:01+00:00",
...
}
Update a Subscription Product
Method: PATCH
URI:
/crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionPUID}/child/products/{SubscriptionProd
uctPUID}
Example:
5678/child/products/GP-5678-PRDT-1
Request Body:
{
"EndDate": "2019-12-20"
}
Response Body:
{
60 | P a g e
"LineNumber": "1",
"Quantity": 1,
"StartDate": "2019-01-01",
"EndDate": "2019-12-20",
"ClosedDate": null,
"UnitPrice": null,
"Currency": "USD",
"BillOnDay": null,
Date]",
"PONumber": null,
"WireNumber": null,
"TaxError": null,
61 | P a g e
"PriceAsOf": "2019-06-04",
"SourceKey": null,
"Duration": 354,
"Period": "DY",
"CreationDate": "2019-06-04T05:18:01+00:00",
...
}
62 | P a g e
Delete a Subscription Product
Method: DELETE
URI:
uctPUID}
Example:
https://zcmw.fa.dc1.c9dev2.oraclecorp.com:443/crmRestApi/resources/latest/subscriptions/CDRM_1/c
hild/products/CDRM_1-PRDT-1
Response Body:
Blank
Get a Subscription Product
Method: GET
URI:
uctPUID}
Example:
hild/products/CDRM_1-PRDT-1
Response Body:
{
"LineNumber": "1",
"SubscriptionProductPuid": "CDRM_1-PRDT-1",
"SubscriptionNumber": "CDRM_1",
63 | P a g e
"Quantity": 1,
"StartDate": "2019-06-03",
"EndDate": "2020-06-02",
"CloseReason": "ORA_NON_COMPLIANCE",
"CloseCreditMethod": "ORA_FULL",
"ClosedDate": "2019-06-08",
"PriceListId": 300100071623855,
"UnitPrice": null,
"Status": "ORA_ACTIVE",
"Currency": "USD",
"BillOnDay": null,
Date]",
"BillToAccountDescription": "Computer Service and Rentals",
"BillToAddress": "301 Summit Hill Drive,CHATTANOOGA, TN 37401",
"PONumber": null,
"WireNumber": null,
"TaxError": null,
"TotalContractValue": 0,
64 | P a g e
"EstimatedTax": 4820,
"PriceAsOf": "2019-06-03",
"CreditedAmount": 0,
"ClosedAmount": 24100,
"SourceKey": null,
"MonthlyRecurringRevenue": 2000,
"Duration": 1,
"Period": "0zE",
"StatusMeaning": "Active",
"CreationDate": "2019-06-03T16:13:44.944+00:00",
"LastUpdateLogin": "8A568A6CC2BCBE27E05323EAF40A845E",
...
}
Get Subscription Products
Method: GET
65 | P a g e
URI: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionPUID}/child/products
Example:
hild/products
Response Body:
{
"items": [
{
"LineNumber": "1",
"Quantity": 1,
"StartDate": "2019-01-01",
"EndDate": "2019-12-25",
"ClosedDate": null,
"UnitPrice": null,
"Currency": "USD",
"BillOnDay": null,
"InvoiceText": "[$Item Name]: [$Charge Name] [$Bill from Date]-
[$Bill to Date]",
66 | P a g e
"PONumber": null,
"WireNumber": null,
"TaxError": null,
"PriceAsOf": "2019-06-04",
"SourceKey": null,
"Duration": 359,
"Period": "DY",
67 | P a g e
"CreationDate": "2019-06-04T05:18:01+00:00",
...
"count": 1,
"hasMore": false,
"limit": 25,
"offset": 0,
"links": [
{
"rel": "self",
"href":
"https://zcmw.fa.dc1.c9dev2.oraclecorp.com:443/crmRestApi/resources/11.13.18.
05/subscriptions/GP-5678/child/products",
"name": "products",
}
]
}
Cancel a Subscription Product (Custom)
Method: POST
URI: /crmRestApi/resources/latest/subscriptionProducts/{SubscriptionProductPUID}
Example:
https://zcmw.fa.dc1.c9dev2.oraclecorp.com:443/crmRestApi/resources/latest/subscriptionProducts/CD
RM_2-PRDT-1
Request Body:
{
"name":"cancel",
"parameters":[
{
"cancelReason":"ORA_PRICING"
},
{
"canceledDate":"2019-06-03"
68 | P a g e
}
]
}
Response Body:
{
"result": "Success"
}
Close a Subscription Product (Custom)
Method: POST
Example:
RM_1-PRDT-1
Request Body:
{
"name":"close",
"parameters":[
{
"closedDate":"2019-06-02"
},
{
"closeReason":"ORA_NON_COMPLIANCE"
},
{
"closeCreditMethod":"ORA_FULL"
}
]
}
Response Body:
{
"result": "Success"
}
Hold a Subscription Product (Custom)
69 | P a g e
Method: POST
Example:
RM_2-PRDT-1
Request Body:
{
"name": "putOnHold"
}
Response Body:
{
"result": "Success"
}
Remove Hold on a Subscription Product (Custom)
Method: POST
Example:
RM_2-PRDT-1
Request Body:
{
"name": "removeHold"
}
Response Body:
{
"result": "Success"
}
70 | P a g e
Suspend a Subscription Product (Custom)
Method: POST
Example:
RM_2-PRDT-1
Request Body:
{
"name":"suspend",
"parameters":[
{
"suspendedDate":"2020-01-27"
},
{
"suspendReason":"ORA_BREACH"
}
]
}
Response Body:
{
"result": "Success"
}
Resume a Subscription Product (Custom)
Method: POST
Example:
RM_2-PRDT-1
71 | P a g e
Request Body:
{
"name":"resume",
"parameters":[
{
"resumeDate":"2020-01-28"
}
]
}
Response Body:
{
"result": "Success"
}
Sample Request Body for Suspend and Resume together
{
"name":"suspend",
"parameters":[
{
"suspendedDate":"2019-03-15"
},
{
"suspendReason":"ORA_BREACH"
},{
"resumeDate":"2019-04-15"
}
]
}
Subscription Product Covered Levels

Create a Subscription Product Covered Level
Method: POST
URI:
uctPUID}/child/coveredLevels
Example:
72 | P a g e
5678/child/products/GP-5678-PRDT-7/child/coveredLevels
Note: This URI can also start from the subscriptionProduct and would look like the following. This is
applicable to all the entities below subscription products.
https://zcmw.fa.dc1.c9dev2.oraclecorp.com:443/crmRestApi/resources/11.13.18.05/subscriptionProduct
s/GP-5678-PRDT-7/child/coveredLevels
Request Body:
{
"CoveredLevelPuid": "GP-5678-PRDT-7-PASS-1",
"LineNumber": "1",
"AssetId": 300100118585763,
"AssetName": "zOKC_Auto_Asset1",
"ProductName": "ZOKC_Item_001",
"Description": "Item",
"Type": "ORA_ASSET",
"Quantity": 1,
"TotalContractValue": 12361.29,
"EndDate": "2019-12-25",
"StartDate": "2019-01-01",
"PriceAsOf": "2019-01-01",
"PriceUnitOfMeasure": "0zE"
}
Response Body:
{
"CoveredLevelId": 300100177254431,
"LineNumber": "1",
"AssetId": 300100118585763,
"AssetSerialNumber": null,
"TypeName": "Asset",
"Quantity": 1,
"EndDate": "2019-12-25",
"StartDate": "2019-01-01",
"Duration": 359,
"Period": "DY",
73 | P a g e
"StatusName": "Draft",
"PriceAsOf": "2019-01-01",
"PriceUnitOfMeasure": "0zE",
"PriceUnitOfMeasureName": "YEAR",
"TaxAmount": null,
"InvoiceText": null,
"ClosedDate": null,
"ReturnCreditMethod": null,
"SuppressedCreditAmount": null,
"RenewalType": null,
"TaxError": null,
"CreationDate": "2019-06-04T18:08:34+00:00",
"CurrencyCode": null,
"CorpCurrencyCode": null,
"CurcyConvRateType": null,
"PutOnHoldFlag": null,
"RemoveHoldFlag": null,
...
}
Update a Subscription Product Covered Level
Method: PATCH
URI:
uctPUID}/child/coveredLevels/{SubscriptionCoveredLevelPUID}
Example:
5678/child/products/GP-5678-PRDT-7/child/coveredLevels/GP-5678-PRDT-7-PASS-1
Request Body:
74 | P a g e
{
"Quantity": 2,
"EndDate": "2019-12-26"
}
Response Body:
{
"LineNumber": "1",
"AssetId": 300100118585763,
"Quantity": 1,
"EndDate": "2019-12-26",
"StartDate": "2019-01-01",
"Duration": 360,
"Period": "DY",
"PriceAsOf": "2019-01-01",
"TaxAmount": null,
"ClosedDate": null,
"TaxError": null,
"CreationDate": "2019-06-04T18:08:34+00:00",
75 | P a g e
...
}
Delete a Subscription Product Covered Level
Method: DELETE
URI:
Example:
Response Body:
Blank
Get a Subscription Product Covered Level
Method: GET
URI:
Example:
Response Body:
76 | P a g e
"LineNumber": "1",
"AssetId": 300100118585763,
"Quantity": 1,
"EndDate": "2019-12-25",
"StartDate": "2019-01-01",
"Duration": 359,
"Period": "DY",
"PriceAsOf": "2019-01-01",
"PriceListId": 300100071623855,
"TaxAmount": 2472.26,
"ClosedDate": null,
"TaxError": null,
"CreationDate": "2019-06-04T17:55:14.831+00:00",
...
}
77 | P a g e
Get Subscription Product Covered Levels
Method: GET
URI:
uctPUID}/child/coveredLevels
Example:
5678/child/products/GP-5678-PRDT-7/child/coveredLevels
Response Body:
{
"items": [
{
"LineNumber": "1",
"AssetId": 300100118585763,
"Quantity": 1,
"EndDate": "2019-12-25",
"StartDate": "2019-01-01",
"Duration": 359,
"Period": "DY",
"PriceAsOf": "2019-01-01",
"PriceListId": 300100071623855,
"TaxAmount": 2472.26,
78 | P a g e
"ClosedDate": null,
"TaxError": null,
"CreationDate": "2019-06-04T17:55:14.831+00:00",
...
}
],
"count": 1,
"hasMore": false,
"limit": 25,
"offset": 0,
...
}
Cancel a Subscription Product Covered Level (Custom)
Method: PATCH
URI:
uctPUID}/child/coveredLevels/{CoveredLevelPUID}
Example:
Request Body:
{
"CancelReason": "ORA_PRICING",
"CanceledDate": "2019-06-05"
79 | P a g e
Response Body:
{
"LineNumber": "1",
"AssetId": 300100118585763,
"Quantity": 1,
"EndDate": "2019-12-25",
"StartDate": "2019-01-01",
"Duration": 359,
"Period": "DY",
"PriceAsOf": "2019-01-01",
"TaxAmount": null,
"CancelReason": "ORA_PRICING",
"CanceledDate": "2019-06-05",
"ClosedDate": null,
"TaxError": null,
"CreationDate": "2019-06-04T18:08:34+00:00",
80 | P a g e
...
}
Close a Subscription Product Covered Level (Custom)
Method: PATCH
URI:
crmRestApi/resources/latest/subscriptions/{SubscriptionPUID}/child/products/{SubscriptionProductPUI
D}/child/coveredLevels/{CoveredLevelPUID}
Example:
Request Body:
{
"ClosedDate" : "2019-06-10",
"CloseReason" : "ORA_NON_COMPLIANCE",
"ReturnCreditMethod" : "ORA_FULL"
}
Response Body:
{
"LineNumber": "1",
"AssetId": 300100118585763,
"Quantity": 1,
"EndDate": "2019-12-25",
"StartDate": "2019-01-01",
81 | P a g e
"Duration": 359,
"Period": "DY",
"Status": "ORA_ACTIVE",
"StatusName": "Active",
"PriceAsOf": "2019-06-05",
"PriceListId": 300100071623855,
"TaxAmount": 0,
"ClosedDate": "2019-06-10",
"CloseReason": "ORA_NON_COMPLIANCE",
"ReturnCreditMethod": "ORA_FULL",
"TaxError": null,
"CreationDate": "2019-06-05T07:19:23.998+00:00",
...
}
Subscription Product Charges

Create a Subscription Product Charge
Method: POST
URI:
D}/child/charges
Example:
82 | P a g e
5678/child/products/GP-5678-PRDT-1/child/charges
Request Body:
{
"BillLineId": null,
"ChargeDefinition": "USAGE_CHARGESPM",
"ChargeName": "USAGE SPM CHARGE",
"TieredFlag": true
}
Response Body:
{
"BillLineId": null,
"ChargeId": 300100177241437,
"RollupFlag": null,
"Allowance": null,
"BlockSize": null,
"TieredFlag": true,
"TierType": null,
"CreationDate": "2019-06-04T13:23:55+00:00",
…
}
Update a Subscription Product Charge
83 | P a g e
Method: PATCH
URI:
D}/child/charges/{ChargePUID}
Example:
5678/child/products/GP-5678-PRDT-1/child/charges/GP-5678-PRDT-1-CHRG-11
Request Body:
{
"TieredFlag": false
}
Response Body:
{
"BillLineId": null,
"ChargeId": 300100177241437,
"RollupFlag": null,
"Allowance": null,
"BlockSize": null,
"TierType": null,
"CreationDate": "2019-06-04T13:23:55+00:00",
…
}
84 | P a g e
Delete a Subscription Product Charge
Method: DELETE
URI:
D}/child/charges/{ChargePUID}
Example:
Response Body:
Blank
Get a Subscription Product Charge
Method: GET
URI:
uctPUID}/child/charges/{ChargePUID}
Example:
Response Body:
{
"BillLineId": null,
"ChargeId": 300100177241437,
85 | P a g e
"RollupFlag": null,
"Allowance": null,
"BlockSize": null,
"TieredFlag": true,
"TierType": null,
"CreationDate": "2019-06-04T13:23:55+00:00",
…
}
Get Subscription Product Charges
Method: GET
URI:
uctPUID}/child/charges
Example:
5678/child/products/GP-5678-PRDT-1/child/charges
Response Body:
{
"items": [
{
"BillLineId": null,
"ChargeDefinition": "ACTIVATIONFEE",
"ChargeId": 300100177231506,
86 | P a g e
"PricePeriodicity": null,
"RollupFlag": false,
"Allowance": null,
"BlockSize": null,
"TieredFlag": null,
"TierType": null,
"PricePeriodicityName": null,
"CreationDate": "2019-06-04T13:03:07.445+00:00",
...
},
{
"BillLineId": null,
"ChargeDefinition": "MONTHLYFEE",
"ChargeId": 300100177231507,
"ChargeName": "Monthly Fee",
"Allowance": null,
"BlockSize": null,
"TieredFlag": null,
"TierType": null,
"CreationDate": "2019-06-04T13:03:07.452+00:00",
…
},
87 | P a g e
{
"BillLineId": null,
"ChargeId": 300100177231508,
"Allowance": null,
"BlockSize": null,
"TieredFlag": true,
"TierType": null,
"CreationDate": "2019-06-04T13:03:07.456+00:00",
…
}
Subscription Product Charge Adjustments

Create a Product Charge Adjustment
Method: POST
URI:
uctPUID}/child/charges/{ChargePUID}/child/adjustments/
Example:
5678/child/products/GP-5678-PRDT-1/child/charges/GP-5678-PRDT-1-CHRG-9/child/adjustments
Request Body:
88 | P a g e
{
"ChargeAdjustmentPuid": "GP-5678-PRDT-1-CHRG-9-MADJ-1",
"Reason": "Special offer",
"AdjustmentName": "One Time Off",
}
Response Body:
{
"ChargeId": 300100177231506,
"PeriodFrom": null,
"CreationDate": "2019-06-04T14:06:49+00:00",
...
}
Update a Product Charge Adjustment
Method: POST
URI:
uctPUID}/child/charges/{ChargePUID}/child/adjustments/{ChargeAdjustmentPUID}
Example:
89 | P a g e
5678/child/products/GP-5678-PRDT-1/child/charges/GP-5678-PRDT-1-CHRG-9/child/adjustments/GP-
5678-PRDT-1-CHRG-9-MADJ-1
Request Body:
{
"AdjustmentValue": 600
}
Response Body:
{
"ChargeId": 300100177231506,
"PeriodFrom": null,
"CreationDate": "2019-06-04T14:06:49+00:00",
...
}
Delete a Product Charge Adjustment
Method: DELETE
URI:
Example:
90 | P a g e
Response Body:
Blank
Get a Product Charge Adjustment
Method: GET
URI:
Example:
Response Body:
{
"ChargeId": 300100177231506,
"PeriodFrom": null,
"AutoAdjustmentFlag": false,
"CreationDate": "2019-06-04T13:54:33.442+00:00",
91 | P a g e
...
}
Get Product Charge Adjustments
Method: GET
URI:
uctPUID}/child/charges/{ChargePUID}/child/adjustments
Example:
Response Body:
{
"items": [
{
"ChargeId": 300100177231506,
"PeriodFrom": null,
"CreationDate": "2019-06-04T13:54:33.442+00:00",
...
"count": 1,
"hasMore": false,
"limit": 25,
92 | P a g e
"offset": 0,
...
}
Subscription Product Bill Lines

Create a Subscription Product Bill Line
Method: POST
URI:
uctPUID}/child/billLines
Example:
5678/child/products/GP-5678-PRDT-1/child/billLines
Request Body:
{
"BillLinePuid": "GP-5678-PRDT-1-BILL-309",
"ChargeId": 300100177231506,
"BillingPeriod": 0,
"DateToInterface": "2019-06-04",
"DateBilledFrom": "2019-01-01",
"DateBilledTo": "2019-12-25",
"Amount": 2600,
"RecurringFlag": false,
"UsageFlag": false,
"UsagePricedFlag": true,
"InterfacedFlag": false,
"TransactionClass": "INV",
"InvoiceText": "[$Item Name]: Activation Fee 2019-01-01-2019-12-25",
"ChargePeriod": 0,
"ListPrice": 3000
}
Response Body:
{
"BillLineId": 300100177242434,
93 | P a g e
"ChargeId": 300100177231506,
"ChargePuid": null,
"BillingPeriod": 0,
"Amount": 2600,
"UsageFlag": false,
"UsageAcquiredFlag": null,
"TransactionDate": null,
"TransactionNumber": null,
"TransactionTax": null,
"TransactionAmount": null,
"InvoiceBillLineId": null,
"UsageCaptureDate": null,
"UsageQuantity": null,
"ChargePeriod": 0,
"ListPrice": 3000,
"RevenueLineId": null,
"CreationDate": "2019-06-04T16:52:11+00:00",
"TransactionClassMeaning": "Invoice",
"InvoiceDate": null,
"NewCreditMemoPUID": null,
"CreditMemoAmount": null,
"CreditMemoFlag": null,
"CreditMemoReason": null,
...
}
Update a Subscription Product Bill Line
Method: PATCH
URI:
uctPUID}/child/billLines/{BillLinePUID}
Example:
94 | P a g e
5678/child/products/GP-5678-PRDT-1/child/billLines/GP-5678-PRDT-1-BILL-309
Request Body:
{
"Amount": 2600
}
Response Body:
{
"BillLineId": 100100108482104,
"ChargeId": 300100177231506,
"ChargePuid": null,
"BillingPeriod": 0,
"Amount": 2600,
"UsageFlag": false,
"ChargePeriod": 0,
"ListPrice": 3000,
"CreationDate": "2019-06-04T13:55:16+00:00",
"InvoiceDate": "2019-06-04",
...
}
95 | P a g e
Update a Subscription Product Bill Line for Usage Quantity
Method: PATCH
URI:
Example:
https://faehyp88.fa.dc1.c9dev2.oraclecorp.com/crmRestApi/resources/latest/subscriptions/CDRM_700
1/child/products/CDRM_7001-PRDT-7002/child/billLines/CDRM_7001-PRDT-7002-BILL-6072
Request Body:
{
"UsageQuantity": 150
}
Response Body:
{
"BillLineId": 100100125204770,
"BillLinePuid": "CDRM_7001-PRDT-7002-BILL-6072",
"ChargeId": 300100184551035,
"ChargePuid": null,
"BillingPeriod": 1,
"Amount": 0,
"RecurringFlag": true,
"UsageFlag": true,
"UsagePricedFlag": false,
"InvoiceText": "[$Item Name]: Data_Storage_Fee 2020-01-30-2020-01-31",
"ChargeDefinition": "USAGE_OSS_DF",
96 | P a g e
"UsageQuantity": 150,
"ChargePeriod": 1,
"ListPrice": 0,
"CreationDate": "2020-01-30T15:55:19+00:00",
"ChargeName": "Data_Storage_Fee",
"TrxId": null,
"TrxLineId": null,
"InvoiceDate": "2020-02-01",
"CustomerTrxTypeSequenceId": 806,
"links": [
...
]
}
Delete a Subscription Product Bill Line
Method: DELETE
URI:
Example:
Response Body:
Blank
97 | P a g e
Get a Subscription Product Bill Line
Method: GET
URI:
Example:
Response Body:
{
"BillLineId": 100100108482104,
"ChargeId": 300100177231506,
"ChargePuid": null,
"BillingPeriod": 0,
"Amount": 2500,
"UsageFlag": false,
"ChargePeriod": 0,
"ListPrice": 3000,
"CreationDate": "2019-06-04T13:55:16+00:00",
98 | P a g e
"InvoiceDate": "2019-06-04",
…
}
Get Subscription Product Bill Lines
Method: GET
URI:
uctPUID}/child/billLines
Example:
Response Body:
{
"items": [
{
"BillLineId": 100100108482104,
"ChargeId": 300100177231506,
"ChargePuid": null,
"BillingPeriod": 0,
"Amount": 2500,
"UsageFlag": false,
99 | P a g e
"InvoiceText": "[$Item Name]: Activation Fee 2019-01-01-2019-12-
25",
"ChargePeriod": 0,
"ListPrice": 3000,
"CreationDate": "2019-06-04T13:55:16+00:00",
"InvoiceDate": "2019-06-04",
…
},
…
]
}
Subscription Product Bill Line Adjustments

Create a Subscription Product Bill Line Adjustment
Method: POST
URI:
uctPUID}/child/billLines/{BillLinePUID}/child/billAdjustments
Example:
7890/child/products/GP-7890-PRDT-6/child/billLines/GP-7890-PRDT-6-BILL-370/child/billAdjustments/
Request Body:
{
"BillAdjustmentPuid": "GP-7890-PRDT-6-BADJ-3",
"AdjustmentName": "$100 off",
100 | P a g e
"AdjustmentBasis": "ORA_LIST_PRICE",
"Reason": "Customer is unhappy with the initial setup delays.",
"AutoAdjustmentFlag": false
}
Response Body:
{
"BillAdjustmentId": 300100177242435,
"BillLineId": 100100108482578,
"ChargeAdjustmentId": null,
"Effectivity": null,
"PeriodFrom": null,
"CreationDate": "2019-06-04T17:34:33+00:00",
"BasisEnableFlag": "false",
...
}
Update a Subscription Product Bill Line Adjustment
Method: POST
URI:
uctPUID}/child/billLines/{BillLinePUID}/child/billAdjustments/{BillAdjustmentPUID}
Example:
101 | P a g e
7890/child/products/GP-7890-PRDT-6/child/billLines/GP-7890-PRDT-6-BILL-
370/child/billAdjustments/GP-7890-PRDT-6-BADJ-3
Request Body:
{
}
Response Body:
{
"BillLineId": 100100108482578,
"PeriodFrom": null,
"CreationDate": "2019-06-04T17:34:33+00:00",
...
}
Delete a Subscription Product Bill Line Adjustment
Method: DELETE
URI:
102 | P a g e
Example:
Response Body:
Blank
Status: 204 Not Content
Get a Subscription Product Bill Line Adjustments
Method: GET
URI:
Example:
Response Body:
{
"BillLineId": 100100108482578,
"PeriodFrom": null,
"CreationDate": "2019-06-04T17:16:03.826+00:00",
103 | P a g e
...
}
Get Subscription Product Bill Line Adjustments
Method: GET
URI:
uctPUID}/child/billLines/{BillLinePUID}/child/billAdjustments
Example:
7890/child/products/GP-7890-PRDT-6/child/billLines/GP-7890-PRDT-6-BILL-370/child/billAdjustments
Response Body:
{
"items": [
{
"BillLineId": 100100108482578,
"PeriodFrom": null,
"CreationDate": "2019-06-04T17:16:03.826+00:00",
104 | P a g e
...
}
],
"count": 1,
"hasMore": false,
"limit": 25,
"offset": 0,
...
}
Subscription Product Sales Credits

Create a Subscription Product Sales Credit
Method: POST
URI:
uctPUID}/child/salesCredits
Example:
5678/child/products/GP-5678-PRDT-1/child/salesCredits
Request Body:
{
"SalesCreditPuid": "GP-5678-PRDT-1-SLCR-3",
"SalesrepId": 100000008147775,
"Percentage": 100
}
Response Body:
{
"CreationDate": "2019-06-05T04:02:15+00:00",
"EndDate": null,
"Percentage": 100,
"SalesCreditId": 300100177241558,
105 | P a g e
"SalesrepId": 100000008147775,
"StartDate": null,
"QuotaFlag": true,
...
}
Update a Subscription Product Sales Credit
Method: POST
URI:
uctPUID}/child/salesCredits/{SalesCreditPUID}
Example:
5678/child/products/GP-5678-PRDT-1/child/salesCredits/GP-5678-PRDT-1-SLCR-4
Request Body:
{
"Percentage": 70
}
Response Body:
{
"CreationDate": "2019-06-05T04:04:47.562+00:00",
"EndDate": null,
"Percentage": 70,
"SalesCreditId": 300100177232430,
"SalesrepId": 100000000177813,
"StartDate": null,
"SalesPerson": "Aaron Wang",
"SalesCreditType": "Non-quota Sales Credit",
106 | P a g e
"QuotaFlag": false,
...
}
Delete a Subscription Product Sales Credit
Method: DELETE
URI:
Example:
Response Body:
Blank
Get a Subscription Product Sales Credit
Method: GET
URI:
Example:
Response Body:
{
107 | P a g e
"CreationDate": "2019-06-05T03:48:02.509+00:00",
"EndDate": null,
"Percentage": 100,
"SalesCreditId": 300100177232429,
"SalesrepId": 100000008147775,
"StartDate": null,
"QuotaFlag": true,
...
}
Get Subscription Product Sales Credits
Method: GET
URI:
uctPUID}/child/salesCredits
Example:
5678/child/products/GP-5678-PRDT-1/child/salesCredits
Response Body:
{
"items": [
{
"CreationDate": "2019-06-05T03:48:02.509+00:00",
"EndDate": null,
"Percentage": 100,
"SalesCreditId": 300100177232429,
"SalesrepId": 100000008147775,
"StartDate": null,
108 | P a g e
"QuotaFlag": true,
...
}
],
"count": 1,
"hasMore": false,
"limit": 25,
"offset": 0,
...
}
Subscription Covered Level Charges

Create a Subscription Covered Level Charge
Method: POST
URI:
uctPUID}/child/coveredLevels/{CoveredLevelPUID}/child/charges
Example:
7788/child/products/GP-7788-PRDT-13/child/coveredLevels/GP-7788-PRDT-13-PASS-
5/child/charges/GP-7788-PRDT-13-CHRG-29/child/adjustments
Request Body:
{
"ChargeName": "Sale Price",
"UnitListPrice": 10000
}
Response Body:
109 | P a g e
"BillLineId": null,
"ChargeId": 300100177242683,
"Allowance": null,
"BlockSize": null,
"TieredFlag": null,
"TierType": null,
"CreationDate": "2019-06-05T07:43:45+00:00",
...
}
Update a Subscription Covered Level Charge
Method: PATCH
URI:
uctPUID}/child/coveredLevels/{CoveredLevelPUID}/child/charges/{ChargePUID}
Example:
5/child/charges/GP-7788-PRDT-13-CHRG-29
Request Body:
{
"UnitListPrice": 9000
}
110 | P a g e
Response Body:
{
"BillLineId": null,
"ChargeId": 300100177242683,
"Allowance": null,
"BlockSize": null,
"TieredFlag": null,
"TierType": null,
"CreationDate": "2019-06-05T07:43:45+00:00",
...
}
Delete a Subscription Covered Level Charge
Method: DELETE
URI:
Example:
111 | P a g e
Response Body:
Blank
Get a Subscription Covered Level Charge
Method: GET
URI:
Example:
Response Body:
{
"BillLineId": null,
"ChargeId": 300100177232490,
"Allowance": null,
"BlockSize": null,
"TieredFlag": null,
"TierType": null,
112 | P a g e
"CreationDate": "2019-06-05T07:28:29+00:00",
...
}
Get Subscription Covered Level Charges
Method: GET
URI:
uctPUID}/child/coveredLevels/{CoveredLevelPUID}/child/charges
Example:
7788/child/products/GP-7788-PRDT-13/child/coveredLevels/GP-7788-PRDT-13-PASS-5/child/charges
Response Body:
{
"items": [
{
"BillLineId": null,
"ChargeId": 300100177232490,
"Allowance": null,
"BlockSize": null,
"TieredFlag": null,
"TierType": null,
"CreationDate": "2019-06-05T07:28:29+00:00",
113 | P a g e
...
},
{
"BillLineId": null,
"ChargeDefinition": "ZOKC_SK_RECURRINGCHARGE",
"ChargeId": 300100177232491,
"ChargeName": "ZOKC_SK_RECURRINGCHARGE",
"Allowance": null,
"BlockSize": null,
"TieredFlag": null,
"TierType": null,
"CreationDate": "2019-06-05T07:28:29.007+00:00",
...
}
],
"count": 2,
"hasMore": false,
"limit": 25,
"offset": 0,
...
}
Subscription Covered Level Charge Adjustments

Create a Covered Level Charge Adjustment
Method: POST
114 | P a g e
URI:
uctPUID}/child/coveredLevels/{CoveredLevelPUID}/child/charges/{ChargePUID}/child/adjustments
Example:
Request Body:
{
"AdjustmentType": "ORA_DISCOUNT_PERCENT",
"Reason": "Special seasonal offer",
"AdjustmentName": "One-time Discount",
}
Response Body:
{
"ChargeId": 300100177242683,
"PeriodFrom": null,
"CreationDate": "2019-06-05T08:12:00+00:00",
...
}
115 | P a g e
Update a Covered Level Charge Adjustment
Method: POST
URI:
Example:
Request Body:
{
"AdjustmentValue": 600
}
Response Body:
{
"ChargeId": 300100177231506,
"PeriodFrom": null,
"CreationDate": "2019-06-04T14:06:49+00:00",
...
}
116 | P a g e
Delete a Covered Level Charge Adjustment
Method: DELETE
URI:
uctPUID}/child/coveredLevels/{CoveredLevelPUID}/child/charges/{ChargePUID}/child/adjustments/{Adj
ustmentPUID}
Example:
5/child/charges/GP-7788-PRDT-13-CHRG-29/child/adjustments/GP-7788-PRDT-13-CHRG-29-MADJ-3
Response Body:
Blank
Get a Covered Level Charge Adjustment
Method: GET
URI:
uctPUID}/child/coveredLevels/{CoveredLevelPUID}/child/charges/{ChargePUID}/child/adjustments/{Adj
ustmentPUID}
Example:
5/child/charges/GP-7788-PRDT-13-CHRG-29/child/adjustments/GP-7788-PRDT-13-CHRG-29-MADJ-3
Response Body:
{
117 | P a g e
"ChargeId": 300100177242683,
"PeriodFrom": null,
"CreationDate": "2019-06-05T07:59:13.728+00:00",
...
}
Get Covered Level Charge Adjustments
Method: GET
URI:
uctPUID}/child/coveredLevels/{CoveredLevelPUID}/child/charges/{ChargePUID}/child/adjustments
Example:
5/child/charges/GP-7788-PRDT-13-CHRG-29/child/adjustments/
Response Body:
{
"items": [
{
"ChargeId": 300100177242683,
"PeriodFrom": null,
118 | P a g e
"CreationDate": "2019-06-05T07:59:13.728+00:00",
…
}
],
"count": 1,
"hasMore": false,
"limit": 25,
"offset": 0,
...
}
Subscription Covered Level Bill Lines

Create a Covered Level Bill Line
Method: POST
URI:
uctPUID}/child/coveredLevels/{CoveredLevelPUID}/child/billLines
Example:
Request Body:
{
"ChargeId": 300100177232491,
"BillingPeriod": 1,
119 | P a g e
"Amount": 200,
"UsageFlag": false,
"InvoiceText": "ZOKC_COVG_MPA_Item: ZOKC_SK_RECURRINGCHARGE 2019-
01-01-2019-01-31",
"ChargePeriod": 1,
"ListPrice": 200
}
Response Body:
{
"BillLineId": 100100108506361,
"ChargeId": 300100177242683,
"ChargePuid": null,
"BillingPeriod": 0,
"Amount": 0,
"UsageFlag": false,
"InvoiceText": "ZOKC_COVG_MPA_Item: Sale Price 2019-01-01-2019-12-31",
"ChargePeriod": 0,
"ListPrice": 9000,
"CreationDate": "2019-06-05T07:59:37+00:00",
"InvoiceDate": "2019-06-05",
120 | P a g e
...
}
Update a Covered Level Bill Line
Method: PATCH
URI:
uctPUID}/child/coveredLevels/{CoveredLevelPUID}/child/billLines/{BillLinePUID}
Example:
5/child/billLines/GP-7788-PRDT-13-BILL-881
Request Body:
{
"Amount": 200
}
Response Body:
{
"BillLineId": 100100108506380,
"ChargeId": 300100177232491,
"ChargePuid": null,
"BillingPeriod": 1,
"Amount": 200,
"UsageFlag": false,
121 | P a g e
"InvoiceText": "ZOKC_COVG_MPA_Item: ZOKC_SK_RECURRINGCHARGE 2019-01-01-
2019-01-31",
"ChargePeriod": 1,
"ListPrice": 200,
"CreationDate": "2019-06-05T07:59:37+00:00",
"InvoiceDate": "2019-06-05",
...
}
Delete a Covered Level Bill Line
Method: DELETE
URI:
uctPUID}/child/coveredLevels/{CoveredLevelPUID}/child/billLines/{BillLinePUID}
Example:
Response Body:
Blank
Get a Covered Level Bill Line
122 | P a g e
Method: GET
URI:
uctPUID}/child/coveredLevel/{CoveredLevelPUID}/child/billLines/{BillLinePUID}
Example:
5/child/billLines/GP-7788-PRDT-13-BILL-879
Response Body:
{
"BillLineId": 100100108506361,
"ChargeId": 300100177242683,
"ChargePuid": null,
"BillingPeriod": 0,
"Amount": 0,
"UsageFlag": false,
"InvoiceText": "ZOKC_COVG_MPA_Item: Sale Price 2019-01-01-2019-12-31",
"ChargePeriod": 0,
"ListPrice": 9000,
"CreationDate": "2019-06-05T07:59:37+00:00",
"InvoiceDate": "2019-06-05",
123 | P a g e
...
}
Get Covered Level Bill Lines
Method: GET
URI:
uctPUID}/child/coveredLevels/{CoveredLevelPUID}/child/billLines
Example:
7788/child/products/GP-7788-PRDT-13/child/coveredLevels/GP-7788-PRDT-13-PASS-5/child/billLines/
Response Body:
{
"items": [
{
"BillLineId": 100100108506361,
"ChargeId": 300100177242683,
"ChargePuid": null,
"BillingPeriod": 0,
"Amount": 0,
"UsageFlag": false,
"InvoiceText": "ZOKC_COVG_MPA_Item: Sale Price 2019-01-01-2019-
12-31",
124 | P a g e
"ChargePeriod": 0,
"ListPrice": 9000,
"CreationDate": "2019-06-05T07:59:37+00:00",
"InvoiceDate": "2019-06-05",
...
},
...
],
"count": 13,
"hasMore": false,
"limit": 25,
"offset": 0,
...
}
Subscription Covered Level Bill Line Adjustments

Create a Covered Level Bill Line Adjustment
Method: POST
URI:
uctPUID}/child/coveredLevels/{CoveredLevelPUID}/child/billLines/{BillLinePUID}/child/billAdjustments
Example:
7890/child/products/GP-7890-PRDT-6/child/billLines/GP-7890-PRDT-6-BILL-370/child/billAdjustments/
Request Body:
{
"BillAdjustmentPuid": "GP-7788-PRDT-13-BILL-931-BADJ-38",
125 | P a g e
"AdjustmentName": "One time discount",
"AutoAdjustmentFlag": false
}
Response Body:
{
"BillLineId": 100100108507019,
"Reason": null,
"PeriodFrom": null,
"CreationDate": "2019-06-05T11:12:52+00:00",
...
}
Update a Covered Level Bill Line Adjustment
Method: POST
URI:
uctPUID}/child/coveredLevels/{CoveredLevelPUID}/child/billLines/{BillLinePUID}/child/billAdjustments/{
BillAdjustmentPUID}
126 | P a g e
Example:
5/child/billLines/GP-7788-PRDT-13-BILL-931/child/billAdjustments/GP-7788-PRDT-13-BILL-931-BADJ-38
Request Body:
{
"AdjustmentType": "ORA_DISCOUNT_AMOUNT"
}
Response Body:
{
"BillLineId": 100100108507019,
"Reason": null,
"PeriodFrom": null,
"CreationDate": "2019-06-05T11:12:52+00:00",
...
}
Delete a Covered Level Bill Line Adjustment
Method: DELETE
URI:
127 | P a g e
BillAdjustmentPUID}
Example:
Response Body:
Blank
Status: 204 Not Content
Get a Covered Level Bill Line Adjustments
Method: GET
URI:
BillAdjustmentPUID}
Example:
Response Body:
{
"BillLineId": 100100108507019,
128 | P a g e
"Reason": null,
"PeriodFrom": null,
"CreationDate": "2019-06-05T10:58:18+00:00",
"LastUpdateLogin": "8A568A61F0F3BE1AE05323EAF40A9340",
...
}
Get Covered Level Bill Line Adjustments
Method: GET
URI:
uctPUID}/child/coveredLevels/{CoveredLevelPUID}/child/billLines/{BillLinePUID}/child/billAdjustments
Example:
5/child/billLines/GP-7788-PRDT-13-BILL-931/child/billAdjustments
Response Body:
{
"items": [
{
"BillLineId": 100100108507019,
"Reason": null,
129 | P a g e
"PeriodFrom": null,
"CreationDate": "2019-06-05T10:58:18+00:00",
…
},
{
"BillLineId": 100100108507019,
"AdjustmentName": "One off discount",
"Reason": "Special discount",
"PeriodFrom": null,
"CreationDate": "2019-06-05T10:59:31.544+00:00",
…
}
],
"count": 2,
"hasMore": false,
"limit": 25,
"offset": 0,
...
}
Asset Transactions
130 | P a g e
Asset Creation
ALM (Installed Base) REST
Method: POST
URI: /fscmRestApi/resources/latest/customerAssets
Example:
https://faehyp88.fa.dc1.c9dev2.oraclecorp.com/fscmRestApi/resources/latest/customerAssets
Request Body:
{
"AssetNumber": "Ballet002",
"Description": "Ballet002",
"CustomerId": 1006,
"CustomerAccountId" : 1006,
"CustomerAccountSiteUseId" : 10921,
"ItemId": 300100172651968,
"ItemOrganizationId": 204,
"Quantity": 1,
"UpdateContractFlag":"N",
"ShipmentDate": "2020-01-26"
}
Response Body:
{
"ActiveEndDate": null,
"AssetId": 300100184794815,
"CurrentLocationContext": "ORA_CUSTOMER",
"CurrentLocationId": null,
"CustomerAccountId": 1006,
"CustomerAccountSiteId": null,
"CustomerAccountSiteUseId": 10921,
"CustomerBillingPartyId": 1006,
"CustomerBillingPartySiteId": null,
"CustomerId": 1006,
"CustomerSiteId": null,
"CustomerSitePartyId": null,
"ItemId": 300100172651968,
"ItemRevision": null,
"LotNumber": null,
"MaintainableFlag": true,
131 | P a g e
"NewWoAllowedFlag": true,
"Quantity": 1,
"SalesOrderId": null,
"SalesOrderLineId": null,
"SalesOrderLineNumber": null,
"SalesOrderNumber": null,
"SalesOrderSourceSystem": null,
"SalesOrderSourceSystemType": null,
"SerialNumber": null,
"ShipmentDate": "2020-01-26T00:00:00+00:00",
"SoldByBusinessUnitId": null,
"ItemNumber": null,
"OrganizationCode": null,
"CurrentLocationName": null,
"UpdateContractFlag": false,
"SourceTransactionDate": "2020-01-27T08:00:07.509+00:00",
"SoldByBusinessUnitName": null,
"CustomerName": null,
"CustomerNumber": null,
"CustomerSitePartyName": null,
"CustomerSitePartyNumber": null,
"CustomerSiteName": null,
"CustomerSiteNumber": null,
"CustomerAccountName": null,
"CustomerAccountNumber": null,
"CustomerAccountSiteName": null,
"CustomerAccountSiteNumber": null,
"CustomerAccountSiteUseCode": null,
"CustomerAssetEndDate": null,
"CustomerAssetStartDate": "2020-01-26T00:00:00+00:00",
"InServiceDate": null,
"InstalledDate": null,
"PurchaseDate": null,
"RegistrationDate": null,
"IotEnabledFlag": true,
"BOMExplosionFlag": null,
"WorkCenterId": null,
"LocationOrganizationId": null,
"DfltWoSubType": null,
"DfltWoType": null,
"links": [
...
]
}
Subscription REST
Method: POST
URI: /crmRestApi/resources/latest/subscriptionAssetTransactions
132 | P a g e
Example:
https://faehyp88.fa.dc1.c9dev2.oraclecorp.com/crmRestApi/resources/latest/subscriptionAssetTransact
ions
Request Body:
"TransactionType": "CUSTOMER_ASSET_CREATION",
"TransactionDate": "2020-01-26",
"AssetId": 300100184794815,
"Quantity": 1,
"CustomerId": 1006,
"BillToAccountSiteUseId":10921
}
Response Body:
{
"TransactionId": 300100184619027,
"TransactionNumber": "ATXN-2011",
"TransactionSequence": 3003,
"TransactionType": "CUSTOMER_ASSET_CREATION",
"TransactionStatus": "PENDING",
"AssetId": 300100184794815,
"Quantity": 1,
"BusinessUnitId": null,
"CustomerId": 1006,
"BillToAccountSiteId": null,
"BillToAccountSiteUseId": 10921,
"SalesOrderSystem": null,
"ReturnOrderSystem": null,
"ReturnOrderId": null,
"ReturnOrderLineId": null,
"ReturnOrderNumber": null,
"ReturnOrderLineNumber": null,
"ReplacementAssetId": null,
"FulfillmentType": null,
"WaitForFulfillment": null,
"PendingFulfillmentCancelled": null,
133 | P a g e
"ShipmentCompleted": null,
"ReturnCompleted": null,
"CreationDate": "2020-01-27T08:07:47+00:00",
"LastUpdateLogin": "9CD6511C8B4A69F9E05323EAF40AFA3C",
"links": [
...
]
}
Asset Expiration
Method: PATCH
URI: /fscmRestApi/resources/latest/customerAssets/{AssetID}
Example:
https://faehyp88.fa.dc1.c9dev2.oraclecorp.com/fscmRestApi/resources/latest/customerAssets/300100
184794815
Request Body:
{
"CustomerAssetEndDate”: "2020-01-27",
"UpdateContractFlag":"N"
}
Response Body:
"AssetId": 300100184794815,
"CustomerId": 1006,
134 | P a g e
"ItemId": 300100172651968,
"LotNumber": null,
"Quantity": 1,
"ShipmentDate": "2020-01-26T00:00:00+00:00",
"ItemNumber": "Ballet PC 2018",
"CurrentLocationName": "Customer address",
"CustomerName": "Computer Service and Rentals",
"CustomerNumber": "1006",
"CustomerAccountName": "Computer Service and Rentals",
"CustomerAccountNumber": "1006",
"CustomerAssetEndDate": "2020-01-27T00:00:00+00:00",
"DfltWoType": null,
"links": [
...
]
}
Subscription REST
135 | P a g e
Method: POST
Example:
ions
Request Body:
{
"TransactionType": "CUSTOMER_ASSET_EXPIRATION",
"AssetId": 300100184794815
}
Request Body:
{
"TransactionId": 300100184619029,
"TransactionType": "CUSTOMER_ASSET_EXPIRATION",
"TransactionStatus": "PENDING",
"AssetId": 300100184794815,
"Quantity": null,
"CustomerId": null,
"BillToAccountId": null,
"BillToAccountSiteUseId": null,
136 | P a g e
"CreationDate": "2020-01-27T08:22:13+00:00",
"LastUpdateLogin": "9CD631BAFCFB801EE05322EAF40A0665",
"links": [
...
]
}
Asset Reinstation
Method: PATCH
URI: /fscmRestApi/resources/latest/customerAssets/{AssetID}
Example:
184794815
Request Body:
{
"CustomerAssetEndDate" : null,
}
{
"AssetId": 300100184794815,
"CustomerId": 1006,
"ItemId": 300100172651968,
137 | P a g e
"LotNumber": null,
"Quantity": 1,
"ShipmentDate": "2020-01-26T00:00:00+00:00",
"DfltWoType": null,
"links": [
...
]
}
Subscription REST
Method: POST
138 | P a g e
Example:
ions
Request Body:
{
"TransactionType": "CUSTOMER_ASSET_REINSTATE",
"AssetId": 300100184794815
}
Response Body:
{
"TransactionId": 300100184802491,
"TransactionType": "CUSTOMER_ASSET_REINSTATE",
"TransactionStatus": "WARNING",
"AssetId": 300100184794815,
"Quantity": null,
"CustomerId": null,
"CreationDate": "2020-01-27T08:44:05+00:00",
139 | P a g e
"LastUpdateLogin": "9CD64491F91069E5E05323EAF40AC27C",
"links": [
...
}
Asset Transfer
Subscription REST
Method: POST
Example:
ions
Request Body:
{
"TransactionType": "CUSTOMER_ASSET_TRANSFER",
"AssetId": 300100168051605,
"CustomerId": 1005,
"BillToAccountSiteUseId": 1023
}
Response Body:
{
"TransactionId": 300100184802493,
"TransactionType": "CUSTOMER_ASSET_TRANSFER",
"AssetId": 300100184794815,
"Quantity": null,
"CustomerId": 1005,
"BillToAccountSiteUseId": 1023,
140 | P a g e
"CreationDate": "2020-01-27T09:01:31+00:00",
"links": [
...
]
}
Asset Return
Subscription REST
Method: POST
Example:
ions
Request Body:
{
"TransactionType": "CUSTOMER_ASSET_RETURN",
"AssetId": 300100184794815
}
Response Body:
141 | P a g e
{
"TransactionId": 300100184802495,
"TransactionType": "CUSTOMER_ASSET_RETURN",
"AssetId": 300100184794815,
"Quantity": null,
"CustomerId": null,
"CreationDate": "2020-01-27T09:08:03+00:00",
"links": [
...
]
}
Asset Split
Method: POST
142 | P a g e
Example:
Request Body:
{
"CustomerId": 1006,
"ItemId": 300100172651968,
"Quantity": 100,
"UpdateContractFlag":"Y",
}
Response Body:
{
"AssetId": 300100184914074,
"CustomerId": 1006,
"ItemId": 300100172651968,
"LotNumber": null,
"Quantity": 100,
"ShipmentDate": "2020-01-30T00:00:00+00:00",
"ItemNumber": null,
143 | P a g e
"DfltWoType": null,
"links": [
...
]
}
Method: PATCH
URI: /fscmRestApi/resources/latest/customerAssets/{Asset ID}
Example:
184914074
Request Body:
{
"Quantity": 80,
}
Response Body:
144 | P a g e
"AssetId": 300100184914074,
"CustomerId": 1006,
"ItemId": 300100172651968,
"LotNumber": null,
"Quantity": 80,
"ShipmentDate": "2020-01-30T00:00:00+00:00",
145 | P a g e
"DfltWoType": null,
"links": [
...
]
}
Method: POST
Example:
Request Body:
{
"CustomerId": 1006,
"ItemId": 300100172651968,
"Quantity": 20,
"UpdateContractFlag":"N",
}
Response Body:
{
"AssetId": 300100184900124,
"CustomerId": 1006,
"ItemId": 300100172651968,
"LotNumber": null,
146 | P a g e
"Quantity": 20,
"ShipmentDate": "2020-01-30T00:00:00+00:00",
"ItemNumber": null,
"DfltWoType": null,
"links": [
...
]
}
Subscription REST
Method: POST
Example:
147 | P a g e
ions
Request Body:
{
"TransactionType": "CUSTOMER_ASSET_SPLIT",
"AssetId": 300100184914074,
"AssetSplitLines":[
{
"AssetId":300100184914074,
"Quantity":"80"
},
{
"AssetId":300100184900124,
"Quantity":"20"
}
]
}
148 | P a g e

Subscription REST Documentation

Uploaded by

Document Informationclick to expand document information

Copyright:

Available Formats

Subscription REST Documentation

Uploaded by

Document Information

Original Title

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

Subscription REST Documentation

Uploaded by

Copyright:

Available Formats

Subscription Management

Delete a Subscription Sales Credit .......................................................................................................... 55

Delete a Product Charge Adjustment ..................................................................................................... 90

Get a Covered Level Charge Adjustment .............................................................................................. 117

Media Type: application/vnd.oracle.adf.resourceitem+json, application/json

"CurrencyName": "US Dollar",

Creation of a Subscription with a product, charges and a charge discount

"InvoiceText": "[$Item Name]: [$Charge Name] [$Bill from Date]-

Media Type: application/vnd.oracle.adf.resourceitem+json, application/json

Media Type: application/vnd.oracle.adf.resourceitem+json, application/json

Status: 204 No Content

Media Type: application/vnd.oracle.adf.resourceitem+json, application/json

Media Type: application/vnd.oracle.adf.resourceitem+json, application/json

Activate a Subscription (Custom)

Media Type: application/vnd.oracle.adf.action+json

Preview a Subscription (Custom)

Media Type: application/vnd.oracle.adf.action+json

Renew a Subscription (Custom)

Media Type: application/vnd.oracle.adf.action+json

Cancel a Subscription (Custom)

Media Type: application/vnd.oracle.adf.action+json

Close a Subscription (Custom)

Media Type: application/vnd.oracle.adf.action+json

Hold a Subscription (Custom)

Media Type: application/vnd.oracle.adf.action+json

Remove Hold on a Subscription (Custom)

Media Type: application/vnd.oracle.adf.action+json

Media Type: application/vnd.oracle.adf.resourceitem+json, application/json

Delete a Subscription Party

Media Type: application/vnd.oracle.adf.resourceitem+json, application/json

Status: 204 No Content

Get a Subscription Party

Media Type: application/vnd.oracle.adf.resourceitem+json, application/json

Get Subscription Parties

Media Type: application/vnd.oracle.adf.resourceitem+json, application/json

Subscription Party Contacts

Media Type: application/vnd.oracle.adf.resourceitem+json, application/json

For creating a team member:

Delete a Subscription Party Contact

Media Type: application/vnd.oracle.adf.resourceitem+json, application/json

Status: 204 No Content

Get a Subscription Party Contact

Media Type: application/vnd.oracle.adf.resourceitem+json, application/json

Get Subscription Party Contacts

Media Type: application/vnd.oracle.adf.resourceitem+json, application/json

Subscription Sales Credits

Media Type: application/vnd.oracle.adf.resourceitem+json, application/json

Update a Subscription Sales Credit

Media Type: application/vnd.oracle.adf.resourceitem+json, application/json

Delete a Subscription Sales Credit

Media Type: application/vnd.oracle.adf.resourceitem+json, application/json

Status: 204 No Content

Get a Subscription Sales Credit

Media Type: application/vnd.oracle.adf.resourceitem+json, application/json

Get Subscription Sales Credits

Media Type: application/vnd.oracle.adf.resourceitem+json, application/json

Create a Subscription Product

Media Type: application/vnd.oracle.adf.resourceitem+json, application/json