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
 Subscription Management REST Documentation

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
 Subscription Management REST Documentation

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
 Subscription Management REST Documentation

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
 Subscription Management REST Documentation

Subscriptions

Create a Subscription

Method: POST

URI: /crmRestApi/resources/[Link]/subscriptions

Media Type: application/[Link]+json, application/json

Example:

[Link]

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,
"SubscriptionNumber": "GP-5678",
"BusinessUnitId": 204,
"BusinessUnitName": "Vision Operations",
"LegalEntityId": 204,
"LegalEntityName": "Vision Operations",
"SubscriptionProfileId": 300100172161473,
"SubscriptionProfileName": "zOSS_SP_ServiceStartActual_Advance_Month",
"PrimaryPartyId": 1001,
"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
 Subscription Management REST Documentation

"CurrencyName": "US Dollar",

"CurrencyConversionRate": null,
"CurrencyConversionRateType": null,
"CurrencyConversionRateDate": null,
"StartDate": "2019-01-01",
"Duration": 1,
"Period": "0zE",
"EndDate": "2019-12-31",
"DefinitionOrganizationId": 204,
"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,
"BillToAccountId": 1001,
"BillToAccountNumber": "1001",
"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
 Subscription Management REST Documentation

"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
 Subscription Management REST Documentation

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

Request Body:

{
"SubscriptionNumber": "GP-3333",
"BusinessUnitId": 204,
"LegalEntityId": 204,
"SubscriptionProfileId": 300100172161474,
"PrimaryPartyId": 1001,
"Currency": "USD",
"StartDate": "2020-01-30",
"EndDate": "2021-01-29",
"DefinitionOrganizationId": 204,
"BillToAccountId": 1001,
"BillToAccountNumber": "1001",
"BillToSiteUseId": 1006,
"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
 Subscription Management REST Documentation

Response Body:

{
"SubscriptionId": 300100184871789,
"SubscriptionNumber": "GP-3333",
"BusinessUnitId": 204,
"BusinessUnitName": "Vision Operations",
"LegalEntityId": 204,
"LegalEntityName": "Vision Operations",
"SubscriptionProfileId": 300100172161474,
"SubscriptionProfileName": "zOSS_SP_CalendarMonthActual_Advance_Month",
"PrimaryPartyId": 1001,
"PrimaryPartyName": "A T & T SOLUTIONS INC",
"PricedOnDate": "2020-01-30T00:00:00+00:00",
"PricingStrategyId": null,
"PricingStrategyExplanation": null,
"PricingSegment": null,
"PricingSegmentExplanation": null,
"SegmentExplanationMessage": null,
"Currency": "USD",
"CurrencyName": "US Dollar",
"CurrencyConversionRate": null,
"CurrencyConversionRateType": null,
"CurrencyConversionRateDate": null,
"StartDate": "2020-01-30",
"Duration": 1,
"Period": "0zE",
"EndDate": "2021-01-29",
"DefinitionOrganizationId": 204,
"DefinitionOrganizationName": "Vision Operations",
"PartialPeriodType": "ORA_ACTUAL",
"PartialPeriodStart": "ORA_CALENDAR",
"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",

10 | P a g e
 Subscription Management REST Documentation

"TransactionTypeName": "ORA_OSS_Invoice",
"BillingSystem": null,
"SubscriptionInvoiceText": "[$Item Name]: [$Charge Name] [$Bill from Date]-
[$Bill to Date]",
"CoverageInvoiceText": null,
"BillToAccountId": 1001,
"BillToAccountNumber": "1001",
"BillToAccountDescription": "A T & T SOLUTIONS INC",
"BillToSiteUseId": 1006,
"BillToAddress": "32 Ave of the Americas , , New York10013 , NY",
"ShipToParty": null,
"ShipToPartyName": null,
"ShipToPartySiteId": null,
"ShipToSite": null,
"PaymentMethod": null,
"PaymentMethodName": null,
"PONumber": null,
"WireNumber": null,
"PaymentTermsId": 1064,
"PaymentTermsName": "Immediate",
"TaxClassificationCode": null,
"TaxClassificationMeaning": null,
"ExemptCertificateNumber": null,
"ExemptReason": null,
"ExemptReasonMeaning": null,
"TaxExemptionHandling": "S",
"TaxExemptionHandlingName": "Standard",
"DocumentFiscalClassification": null,
"CustomerAcceptance": "NOTREQUIRED",
"InternalApproval": "NOTREQUIRED",
"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,

11 | P a g e
 Subscription Management REST Documentation

"DefaultLanguage": null,
"GenerateBillingSchedule": "Y",
"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": "2020-01-30T16:26:03+00:00",
"LastUpdatedBy": "CONMGR",
"LastUpdateDate": "2020-01-30T16:26:10.614+00:00",
"LastUpdateLogin": "9CD631AD91BF8018E05322EAF40AD740",
"CustomerTrxTypeSequenceId": null,
"UsageCapture": "ORA_THIRD_PARTY",
"products": [
{
"SubscriptionProductId": 300100184871792,
"SubscriptionId": 300100184871789,
"LineNumber": "P1",
"SubscriptionProductPuid": "GP-3333-PRDT-7004",
"DefinitionOrganizationId": 204,
"SubscriptionNumber": "GP-3333",
"SalesProductType": "SUBSCRIPTION",
"Description": "Cloud Backup Service",
"InventoryItemId": 300100178580511,
"ItemUnitOfMeasure": "Ea",
"ProductName": "Cloud Backup Service",
"Quantity": 1,
"StartDate": "2020-01-30",
"EndDate": "2021-01-29",
"CloseReason": null,
"CloseCreditMethod": null,
"CancelReason": null,
"ClosedDate": null,
"CanceledDate": null,
"RenewedDate": null,
"PriceListId": null,
"UnitPrice": null,
"Status": "ORA_DRAFT",
"Currency": "USD",
"InvoicingRuleId": -2,
"InvoicingRuleName": "Advance Invoice",
"BillOnDay": null,
"BillingOffsetDays": null,
"BillingFrequency": "0zG",
"BillingFrequencyName": "MONTH",
"AccountingRuleId": 300100033038413,
"AccountingRuleName": "3 Months, Deferred",
"TransactionTypeName": "ORA_OSS_Invoice",

12 | P a g e
 Subscription Management REST Documentation

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

[$Bill to Date]",
"BillToAccountId": 1001,
"BillToAccountNumber": "1001",
"BillToAccountDescription": "A T & T SOLUTIONS INC",
"BillToSiteUseId": 1006,
"BillToAddress": "32 Ave of the Americas , , New York10013 , NY",
"ShipToPartyId": null,
"ShipToPartyName": null,
"ShipToPartySiteId": null,
"ShipToPartySiteName": null,
"PaymentMethod": null,
"PaymentMethodName": null,
"PONumber": null,
"WireNumber": null,
"PaymentTermsId": 1064,
"PaymentTermsName": "Immediate",
"PrePaymentNumber": null,
"TaxExemptionHandling": "S",
"TaxExemptionHandlingName": "Standard",
"ExemptCertificateNumber": null,
"ExemptReason": null,
"OutputTaxClassification": null,
"ProductFiscClassification": null,
"TaxError": null,
"CoverageScheduleId": null,
"RenewalType": "RENEW",
"BillingDateCode": "ORA_PERIOD_START",
"BillingDateName": "Period start",
"TotalContractValue": null,
"EstimatedTax": null,
"PricingError": null,
"PriceAsOf": "2020-01-30",
"PriceTransactionOn": "2020-01-30",
"InvoicedAmount": null,
"CreditedAmount": null,
"CanceledAmount": null,
"ClosedAmount": null,
"SourceSystem": null,
"SourceKey": null,
"SourceNumber": null,
"SourceLineKey": null,
"SourceLineNumber": null,
"MonthlyRecurringRevenue": null,
"Duration": 1,
"Period": "0zE",
"GenerateBillingSchedule": "Y",
"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
 Subscription Management REST Documentation

"PricingTermsAdjustmentPCT": null,
"CorpCurrencyCode": "USD",
"CurcyConvRateType": "Corporate",
"AmendCreditMethod": null,
"AmendCreditMethodName": null,
"AmendDescription": null,
"AmendEffectiveDate": null,
"AmendReason": null,
"AmendReasonName": null,
"StatusMeaning": "Draft",
"EnablePricingTermsFlag": null,
"NextBillStartDate": null,
"TaxClassificationMeaning": null,
"CreatedBy": "CONMGR",
"CreationDate": "2020-01-30T16:26:03.607+00:00",
"LastUpdatedBy": "CONMGR",
"LastUpdateDate": "2020-01-30T16:26:10.636+00:00",
"LastUpdateLogin": "9CD631AD91BF8018E05322EAF40AD740",
"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,
"PrePaymentNumber": null,
"PricePeriodicity": "0zG",
"PriceType": "ONE_TIME",
"RollupFlag": null,
"SequenceNumber": null,
"SubscriptionId": 300100184871789,
"SubscriptionProductId": 300100184871792,
"ChargeName": "Activation Fee",
"ExternalKey": null,
"ExternalParentKey": null,
"UnitListPrice": 500,
"Allowance": null,
"BlockSize": null,
"TieredFlag": false,
"TierType": null,
"UsagePriceLockFlag": null,
"PricePeriodicityName": "MONTH",
"ChargeDefinitionName": null,
"CreatedBy": "CONMGR",
"CreationDate": "2020-01-30T16:26:03.808+00:00",
"LastUpdateDate": "2020-01-30T16:26:10.639+00:00",

14 | P a g e
 Subscription Management REST Documentation

"LastUpdateLogin": "9CD631AD91BF8018E05322EAF40AD740",
"LastUpdatedBy": "CONMGR",
"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",
"AdjustmentValue": 50,
"AdjustmentBasis": null,
"Reason": "Special festival offer",
"SequenceNumber": 1,
"SubscriptionId": 300100184871789,
"SubscriptionProductId": 300100184871792,
"AdjustmentName": "Spl Discount",
"AutoAdjustmentFlag": null,
"Effectivity": "ORA_ALL_TERM",
"NumberOfPeriods": null,
"ObjectVersionNumber": 1,
"CreatedBy": "CONMGR",
"CreationDate": "2020-01-30T16:26:03.971+00:00",
"LastUpdateDate": "2020-01-30T16:26:10.662+00:00",
"LastUpdateLogin": "9CD631AD91BF8018E05322EAF40AD740",
"LastUpdatedBy": "CONMGR",
"links": [
{
"rel": "self",
"href": "[Link]
crmRestApi/resources/[Link]/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",
"href": "[Link]
crmRestApi/resources/[Link]/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"

15 | P a g e
 Subscription Management REST Documentation

},
{
"rel": "parent",
"href": "[Link]
crmRestApi/resources/[Link]/subscriptions/GP-3333/child/products/GP-
3333-PRDT-7004/child/charges/GP-3333-PRDT-7004-CHRG-6006",
"name": "charges",
"kind": "item"
},
{
"rel": "lov",
"href": "[Link]
crmRestApi/resources/[Link]/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/lov/AdjustmentBasisLookupVA",
"name": "AdjustmentBasisLookupVA",
"kind": "collection"
},
{
"rel": "lov",
"href": "[Link]
crmRestApi/resources/[Link]/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/lov/AdjustmentEffectivityLookupVA",
"name": "AdjustmentEffectivityLookupVA",
"kind": "collection"
},
{
"rel": "lov",
"href": "[Link]
crmRestApi/resources/[Link]/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/lov/AdjustmentTypeLookupVA",
"name": "AdjustmentTypeLookupVA",
"kind": "collection"
}
]
}
],
"links": [
{
"rel": "self",
"href": "[Link]
estApi/resources/[Link]/subscriptions/GP-3333/child/products/GP-3333-
PRDT-7004/child/charges/GP-3333-PRDT-7004-CHRG-6006",
"name": "charges",
"kind": "item",
"properties": {
"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727
261794C6973747881D21D99C7619D03000149000473697A657870000000017704000000017372
00116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C75657
87200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
}
},

16 | P a g e
 Subscription Management REST Documentation

{
"rel": "canonical",
"href": "[Link]
estApi/resources/[Link]/subscriptions/GP-3333/child/products/GP-3333-
PRDT-7004/child/charges/GP-3333-PRDT-7004-CHRG-6006",
"name": "charges",
"kind": "item"
},
{
"rel": "parent",
"href": "[Link]
estApi/resources/[Link]/subscriptions/GP-3333/child/products/GP-3333-
PRDT-7004",
"name": "products",
"kind": "item"
},
{
"rel": "lov",
"href": "[Link]
estApi/resources/[Link]/subscriptions/GP-3333/child/products/GP-3333-
PRDT-7004/child/charges/GP-3333-PRDT-7004-CHRG-6006/lov/PaymentSetIdVA",
"name": "PaymentSetIdVA",
"kind": "collection"
},
{
"rel": "lov",
"href": "[Link]
estApi/resources/[Link]/subscriptions/GP-3333/child/products/GP-3333-
PRDT-7004/child/charges/GP-3333-PRDT-7004-CHRG-6006/lov/TierTypePVO",
"name": "TierTypePVO",
"kind": "collection"
},
{
"rel": "child",
"href": "[Link]
estApi/resources/[Link]/subscriptions/GP-3333/child/products/GP-3333-
PRDT-7004/child/charges/GP-3333-PRDT-7004-CHRG-6006/child/adjustments",
"name": "adjustments",
"kind": "collection"
},
{
"rel": "child",
"href": "[Link]
estApi/resources/[Link]/subscriptions/GP-3333/child/products/GP-3333-
PRDT-7004/child/charges/GP-3333-PRDT-7004-CHRG-6006/child/chargeTiers",
"name": "chargeTiers",
"kind": "collection"
}
]
},
{
"BillLineId": null,
"ChargeDefinition": "QP_RECURRING_SALE_PRICE",
"ChargeId": 300100184871795,
"ChargePuid": "GP-3333-PRDT-7004-CHRG-6007",
"CoveredLevelId": null,
"PrePaymentNumber": null,

17 | P a g e
 Subscription Management REST Documentation

"PricePeriodicity": "0zG",
"PriceType": "RECURRING",
"RollupFlag": null,
"SequenceNumber": null,
"SubscriptionId": 300100184871789,
"SubscriptionProductId": 300100184871792,
"ChargeName": "Monthly Recurring Fee",
"ExternalKey": null,
"ExternalParentKey": null,
"UnitListPrice": 5.99,
"Allowance": null,
"BlockSize": null,
"TieredFlag": false,
"TierType": null,
"UsagePriceLockFlag": null,
"PricePeriodicityName": "MONTH",
"ChargeDefinitionName": null,
"CreatedBy": "CONMGR",
"CreationDate": "2020-01-30T16:26:04.121+00:00",
"LastUpdateDate": "2020-01-30T16:26:10.676+00:00",
"LastUpdateLogin": "9CD631AD91BF8018E05322EAF40AD740",
"LastUpdatedBy": "CONMGR",
"MeterDefinitionId": null,
"MeterId": null,
"InitialMeterReadingId": null,
"AggregationMethod": null,
"AssetMeterYn": null,
"links": [
{
"rel": "self",
"href": "[Link]
estApi/resources/[Link]/subscriptions/GP-3333/child/products/GP-3333-
PRDT-7004/child/charges/GP-3333-PRDT-7004-CHRG-6007",
"name": "charges",
"kind": "item",
"properties": {
"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727
261794C6973747881D21D99C7619D03000149000473697A657870000000017704000000017372
00116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C75657
87200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
}
},
{
"rel": "canonical",
"href": "[Link]
estApi/resources/[Link]/subscriptions/GP-3333/child/products/GP-3333-
PRDT-7004/child/charges/GP-3333-PRDT-7004-CHRG-6007",
"name": "charges",
"kind": "item"
},
{
"rel": "parent",
"href": "[Link]
estApi/resources/[Link]/subscriptions/GP-3333/child/products/GP-3333-
PRDT-7004",
"name": "products",
"kind": "item"

18 | P a g e
 Subscription Management REST Documentation

},
{
"rel": "lov",
"href": "[Link]
estApi/resources/[Link]/subscriptions/GP-3333/child/products/GP-3333-
PRDT-7004/child/charges/GP-3333-PRDT-7004-CHRG-6007/lov/PaymentSetIdVA",
"name": "PaymentSetIdVA",
"kind": "collection"
},
{
"rel": "lov",
"href": "[Link]
estApi/resources/[Link]/subscriptions/GP-3333/child/products/GP-3333-
PRDT-7004/child/charges/GP-3333-PRDT-7004-CHRG-6007/lov/TierTypePVO",
"name": "TierTypePVO",
"kind": "collection"
},
{
"rel": "child",
"href": "[Link]
estApi/resources/[Link]/subscriptions/GP-3333/child/products/GP-3333-
PRDT-7004/child/charges/GP-3333-PRDT-7004-CHRG-6007/child/adjustments",
"name": "adjustments",
"kind": "collection"
},
{
"rel": "child",
"href": "[Link]
estApi/resources/[Link]/subscriptions/GP-3333/child/products/GP-3333-
PRDT-7004/child/charges/GP-3333-PRDT-7004-CHRG-6007/child/chargeTiers",
"name": "chargeTiers",
"kind": "collection"
}
]
}
],
"links": [
{
"rel": "self",
"href": "[Link]
pi/resources/[Link]/subscriptions/GP-3333/child/products/GP-3333-PRDT-
7004",
"name": "products",
"kind": "item",
"properties": {
"changeIndicator": "ACED0005737200136A6176612E7574696C2E417272617
94C6973747881D21D99C7619D03000149000473697A6578700000000177040000000173720011
6A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C756578720
0106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
}
},
{
"rel": "canonical",
"href": "[Link]
pi/resources/[Link]/subscriptions/GP-3333/child/products/GP-3333-PRDT-
7004",
"name": "products",

19 | P a g e
 Subscription Management REST Documentation

"kind": "item"
},
{
"rel": "parent",
"href": "[Link]
pi/resources/[Link]/subscriptions/GP-3333",
"name": "subscriptions",
"kind": "item"
},
{
"rel": "lov",
"href": "[Link]
pi/resources/[Link]/subscriptions/GP-3333/child/products/GP-3333-PRDT-
7004/lov/BillingDateCodeVA",
"name": "BillingDateCodeVA",
"kind": "collection"
},
{
"rel": "lov",
"href": "[Link]
pi/resources/[Link]/subscriptions/GP-3333/child/products/GP-3333-PRDT-
7004/lov/SubscriptionCoverageHeaderVA",
"name": "SubscriptionCoverageHeaderVA",
"kind": "collection"
},
{
"rel": "lov",
"href": "[Link]
pi/resources/[Link]/subscriptions/GP-3333/child/products/GP-3333-PRDT-
7004/lov/AmendCreditMethodVA",
"name": "AmendCreditMethodVA",
"kind": "collection"
},
{
"rel": "lov",
"href": "[Link]
pi/resources/[Link]/subscriptions/GP-3333/child/products/GP-3333-PRDT-
7004/lov/AccountingRuleVA",
"name": "AccountingRuleVA",
"kind": "collection"
},
{
"rel": "lov",
"href": "[Link]
pi/resources/[Link]/subscriptions/GP-3333/child/products/GP-3333-PRDT-
7004/lov/ShipToPartyVA",
"name": "ShipToPartyVA",
"kind": "collection"
},
{
"rel": "lov",
"href": "[Link]
pi/resources/[Link]/subscriptions/GP-3333/child/products/GP-3333-PRDT-
7004/lov/PaymentTermsVA",
"name": "PaymentTermsVA",
"kind": "collection"
},

20 | P a g e
 Subscription Management REST Documentation

{
"rel": "lov",
"href": "[Link]
pi/resources/[Link]/subscriptions/GP-3333/child/products/GP-3333-PRDT-
7004/lov/PeriodVA",
"name": "PeriodVA",
"kind": "collection"
},
{
"rel": "lov",
"href": "[Link]
pi/resources/[Link]/subscriptions/GP-3333/child/products/GP-3333-PRDT-
7004/lov/TaxExemptionControlVA",
"name": "TaxExemptionControlVA",
"kind": "collection"
},
{
"rel": "lov",
"href": "[Link]
pi/resources/[Link]/subscriptions/GP-3333/child/products/GP-3333-PRDT-
7004/lov/ItemNameVA",
"name": "ItemNameVA",
"kind": "collection"
},
{
"rel": "lov",
"href": "[Link]
pi/resources/[Link]/subscriptions/GP-3333/child/products/GP-3333-PRDT-
7004/lov/BillToAccountVA",
"name": "BillToAccountVA",
"kind": "collection"
},
{
"rel": "lov",
"href": "[Link]
pi/resources/[Link]/subscriptions/GP-3333/child/products/GP-3333-PRDT-
7004/lov/PaymentMethodVA",
"name": "PaymentMethodVA",
"kind": "collection"
},
{
"rel": "lov",
"href": "[Link]
pi/resources/[Link]/subscriptions/GP-3333/child/products/GP-3333-PRDT-
7004/lov/PaymentSetIdVA",
"name": "PaymentSetIdVA",
"kind": "collection"
},
{
"rel": "lov",
"href": "[Link]
pi/resources/[Link]/subscriptions/GP-3333/child/products/GP-3333-PRDT-
7004/lov/AmendReasonVA",
"name": "AmendReasonVA",
"kind": "collection"
},
{

21 | P a g e
 Subscription Management REST Documentation

"rel": "lov",
"href": "[Link]
pi/resources/[Link]/subscriptions/GP-3333/child/products/GP-3333-PRDT-
7004/lov/BillingDayLOVVO",
"name": "BillingDayLOVVO",
"kind": "collection"
},
{
"rel": "lov",
"href": "[Link]
pi/resources/[Link]/subscriptions/GP-3333/child/products/GP-3333-PRDT-
7004/lov/InvoiceRuleVA",
"name": "InvoiceRuleVA",
"kind": "collection"
},
{
"rel": "lov",
"href": "[Link]
pi/resources/[Link]/subscriptions/GP-3333/child/products/GP-3333-PRDT-
7004/lov/RenewalTypeVA",
"name": "RenewalTypeVA",
"kind": "collection"
},
{
"rel": "lov",
"href": "[Link]
pi/resources/[Link]/subscriptions/GP-3333/child/products/GP-3333-PRDT-
7004/lov/PricingMethodVA",
"name": "PricingMethodVA",
"kind": "collection"
},
{
"rel": "lov",
"href": "[Link]
pi/resources/[Link]/subscriptions/GP-3333/child/products/GP-3333-PRDT-
7004/lov/TimeUnitOfMeasureVA",
"name": "TimeUnitOfMeasureVA",
"kind": "collection"
},
{
"rel": "lov",
"href": "[Link]
pi/resources/[Link]/subscriptions/GP-3333/child/products/GP-3333-PRDT-
7004/lov/CloseCreditMethodVO",
"name": "CloseCreditMethodVO",
"kind": "collection"
},
{
"rel": "lov",
"href": "[Link]
pi/resources/[Link]/subscriptions/GP-3333/child/products/GP-3333-PRDT-
7004/lov/SalesProductTypeLookupVA",
"name": "SalesProductTypeLookupVA",
"kind": "collection"
},
{
"rel": "lov",

22 | P a g e
 Subscription Management REST Documentation

"href": "[Link]
pi/resources/[Link]/subscriptions/GP-3333/child/products/GP-3333-PRDT-
7004/lov/ShipToPartySiteVA",
"name": "ShipToPartySiteVA",
"kind": "collection"
},
{
"rel": "child",
"href": "[Link]
pi/resources/[Link]/subscriptions/GP-3333/child/products/GP-3333-PRDT-
7004/child/billLines",
"name": "billLines",
"kind": "collection"
},
{
"rel": "child",
"href": "[Link]
pi/resources/[Link]/subscriptions/GP-3333/child/products/GP-3333-PRDT-
7004/child/charges",
"name": "charges",
"kind": "collection"
},
{
"rel": "child",
"href": "[Link]
pi/resources/[Link]/subscriptions/GP-3333/child/products/GP-3333-PRDT-
7004/child/coveredLevels",
"name": "coveredLevels",
"kind": "collection"
},
{
"rel": "child",
"href": "[Link]
pi/resources/[Link]/subscriptions/GP-3333/child/products/GP-3333-PRDT-
7004/child/creditCards",
"name": "creditCards",
"kind": "collection"
},
{
"rel": "child",
"href": "[Link]
pi/resources/[Link]/subscriptions/GP-3333/child/products/GP-3333-PRDT-
7004/child/relationships",
"name": "relationships",
"kind": "collection"
},
{
"rel": "child",
"href": "[Link]
pi/resources/[Link]/subscriptions/GP-3333/child/products/GP-3333-PRDT-
7004/child/salesCredits",
"name": "salesCredits",
"kind": "collection"
},
{
"rel": "action",

23 | P a g e
 Subscription Management REST Documentation

"href": "[Link]
pi/resources/[Link]/subscriptions/GP-3333/child/products/GP-3333-PRDT-
7004/action/putOnHold",
"name": "putOnHold",
"kind": "other"
},
{
"rel": "action",
"href": "[Link]
pi/resources/[Link]/subscriptions/GP-3333/child/products/GP-3333-PRDT-
7004/action/removeHold",
"name": "removeHold",
"kind": "other"
},
{
"rel": "action",
"href": "[Link]
pi/resources/[Link]/subscriptions/GP-3333/child/products/GP-3333-PRDT-
7004/action/cancel",
"name": "cancel",
"kind": "other"
},
{
"rel": "action",
"href": "[Link]
pi/resources/[Link]/subscriptions/GP-3333/child/products/GP-3333-PRDT-
7004/action/close",
"name": "close",
"kind": "other"
},
{
"rel": "action",
"href": "[Link]
pi/resources/[Link]/subscriptions/GP-3333/child/products/GP-3333-PRDT-
7004/action/suspend",
"name": "suspend",
"kind": "other"
},
{
"rel": "action",
"href": "[Link]
pi/resources/[Link]/subscriptions/GP-3333/child/products/GP-3333-PRDT-
7004/action/resume",
"name": "resume",
"kind": "other"
}
]
}
],
"links": [
{
"rel": "self",
"href": "[Link]
esources/[Link]/subscriptions/GP-3333",
"name": "subscriptions",
"kind": "item",
"properties": {

24 | P a g e
 Subscription Management REST Documentation

"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6
973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A61
76612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106
A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
}
},
{
"rel": "canonical",
"href": "[Link]
esources/[Link]/subscriptions/GP-3333",
"name": "subscriptions",
"kind": "item"
},
{
"rel": "lov",
"href": "[Link]
esources/[Link]/subscriptions/GP-3333/lov/ConversionRateTypeVA",
"name": "ConversionRateTypeVA",
"kind": "collection"
},
{
"rel": "lov",
"href": "[Link]
esources/[Link]/subscriptions/GP-3333/lov/CancelReasonVA",
"name": "CancelReasonVA",
"kind": "collection"
},
{
"rel": "lov",
"href": "[Link]
esources/[Link]/subscriptions/GP-3333/lov/PriceAdjustmentTypeVA",
"name": "PriceAdjustmentTypeVA",
"kind": "collection"
},
{
"rel": "lov",
"href": "[Link]
esources/[Link]/subscriptions/GP-3333/lov/PaymentTermsVA",
"name": "PaymentTermsVA",
"kind": "collection"
},
{
"rel": "lov",
"href": "[Link]
esources/[Link]/subscriptions/GP-3333/lov/CurrencyVA",
"name": "CurrencyVA",
"kind": "collection"
},
{
"rel": "lov",
"href": "[Link]
esources/[Link]/subscriptions/GP-3333/lov/PeriodVA",
"name": "PeriodVA",
"kind": "collection"
},
{
"rel": "lov",

25 | P a g e
 Subscription Management REST Documentation

"href": "[Link]
esources/[Link]/subscriptions/GP-3333/lov/CommunicationChannelVA",
"name": "CommunicationChannelVA",
"kind": "collection"
},
{
"rel": "lov",
"href": "[Link]
esources/[Link]/subscriptions/GP-3333/lov/StatusVA",
"name": "StatusVA",
"kind": "collection"
},
{
"rel": "lov",
"href": "[Link]
esources/[Link]/subscriptions/GP-3333/lov/InternalApprovalVA",
"name": "InternalApprovalVA",
"kind": "collection"
},
{
"rel": "lov",
"href": "[Link]
esources/[Link]/subscriptions/GP-3333/lov/RenewalTypeVA",
"name": "RenewalTypeVA",
"kind": "collection"
},
{
"rel": "lov",
"href": "[Link]
esources/[Link]/subscriptions/GP-3333/lov/LanguageVA",
"name": "LanguageVA",
"kind": "collection"
},
{
"rel": "lov",
"href": "[Link]
esources/[Link]/subscriptions/GP-3333/lov/LayoutTemplateVA",
"name": "LayoutTemplateVA",
"kind": "collection"
},
{
"rel": "lov",
"href": "[Link]
esources/[Link]/subscriptions/GP-3333/lov/BillServiceVA",
"name": "BillServiceVA",
"kind": "collection"
},
{
"rel": "lov",
"href": "[Link]
esources/[Link]/subscriptions/GP-3333/lov/BusinessUnitVA",
"name": "BusinessUnitVA",
"kind": "collection"
},
{
"rel": "lov",

26 | P a g e
 Subscription Management REST Documentation

"href": "[Link]
esources/[Link]/subscriptions/GP-3333/lov/ShipToPartySiteVA",
"name": "ShipToPartySiteVA",
"kind": "collection"
},
{
"rel": "lov",
"href": "[Link]
esources/[Link]/subscriptions/GP-3333/lov/PriceAdjustmentBasisVA",
"name": "PriceAdjustmentBasisVA",
"kind": "collection"
},
{
"rel": "lov",
"href": "[Link]
esources/[Link]/subscriptions/GP-3333/lov/BillingDateCodeVA",
"name": "BillingDateCodeVA",
"kind": "collection"
},
{
"rel": "lov",
"href": "[Link]
esources/[Link]/subscriptions/GP-3333/lov/AccountingRuleVA",
"name": "AccountingRuleVA",
"kind": "collection"
},
{
"rel": "lov",
"href": "[Link]
esources/[Link]/subscriptions/GP-3333/lov/SubscriptionsPaymentMethodVA",
"name": "SubscriptionsPaymentMethodVA",
"kind": "collection"
},
{
"rel": "lov",
"href": "[Link]
esources/[Link]/subscriptions/GP-3333/lov/CustomerAcceptanceVA",
"name": "CustomerAcceptanceVA",
"kind": "collection"
},
{
"rel": "lov",
"href": "[Link]
esources/[Link]/subscriptions/GP-3333/lov/ShipToPartyVA",
"name": "ShipToPartyVA",
"kind": "collection"
},
{
"rel": "lov",
"href": "[Link]
esources/[Link]/subscriptions/GP-3333/lov/UserPVA",
"name": "UserPVA",
"kind": "collection"
},
{
"rel": "lov",

27 | P a g e
 Subscription Management REST Documentation

"href": "[Link]
esources/[Link]/subscriptions/GP-3333/lov/TaxExemptionControlVA",
"name": "TaxExemptionControlVA",
"kind": "collection"
},
{
"rel": "lov",
"href": "[Link]
esources/[Link]/subscriptions/GP-3333/lov/DefinitionOrgVA",
"name": "DefinitionOrgVA",
"kind": "collection"
},
{
"rel": "lov",
"href": "[Link]
esources/[Link]/subscriptions/GP-3333/lov/LegalEntityAllVA",
"name": "LegalEntityAllVA",
"kind": "collection"
},
{
"rel": "lov",
"href": "[Link]
esources/[Link]/subscriptions/GP-3333/lov/BillToAccountVA",
"name": "BillToAccountVA",
"kind": "collection"
},
{
"rel": "lov",
"href": "[Link]
esources/[Link]/subscriptions/GP-3333/lov/CloseReasonVA",
"name": "CloseReasonVA",
"kind": "collection"
},
{
"rel": "lov",
"href": "[Link]
esources/[Link]/subscriptions/GP-3333/lov/OutputTaxClassificationVA",
"name": "OutputTaxClassificationVA",
"kind": "collection"
},
{
"rel": "lov",
"href": "[Link]
esources/[Link]/subscriptions/GP-3333/lov/BillingDayLOVVO",
"name": "BillingDayLOVVO",
"kind": "collection"
},
{
"rel": "lov",
"href": "[Link]
esources/[Link]/subscriptions/GP-3333/lov/ExemptCertificateVA",
"name": "ExemptCertificateVA",
"kind": "collection"
},
{
"rel": "lov",

28 | P a g e
 Subscription Management REST Documentation

"href": "[Link]
esources/[Link]/subscriptions/GP-3333/lov/InvoiceRuleVA",
"name": "InvoiceRuleVA",
"kind": "collection"
},
{
"rel": "lov",
"href": "[Link]
esources/[Link]/subscriptions/GP-3333/lov/DocFiscalClassificationVA",
"name": "DocFiscalClassificationVA",
"kind": "collection"
},
{
"rel": "lov",
"href": "[Link]
esources/[Link]/subscriptions/GP-3333/lov/SubscriptionProfileVA",
"name": "SubscriptionProfileVA",
"kind": "collection"
},
{
"rel": "lov",
"href": "[Link]
esources/[Link]/subscriptions/GP-3333/lov/PrimaryPartyVA",
"name": "PrimaryPartyVA",
"kind": "collection"
},
{
"rel": "lov",
"href": "[Link]
esources/[Link]/subscriptions/GP-3333/lov/BillingFrequencyVA",
"name": "BillingFrequencyVA",
"kind": "collection"
},
{
"rel": "child",
"href": "[Link]
esources/[Link]/subscriptions/GP-3333/child/contractAttachment",
"name": "contractAttachment",
"kind": "collection"
},
{
"rel": "child",
"href": "[Link]
esources/[Link]/subscriptions/GP-3333/child/parties",
"name": "parties",
"kind": "collection"
},
{
"rel": "child",
"href": "[Link]
esources/[Link]/subscriptions/GP-3333/child/products",
"name": "products",
"kind": "collection"
},
{
"rel": "child",

29 | P a g e
 Subscription Management REST Documentation

"href": "[Link]
esources/[Link]/subscriptions/GP-3333/child/salesCredits",
"name": "salesCredits",
"kind": "collection"
},
{
"rel": "child",
"href": "[Link]
esources/[Link]/subscriptions/GP-
3333/child/supportingDocumentAttachments",
"name": "supportingDocumentAttachments",
"kind": "collection"
},
{
"rel": "child",
"href": "[Link]
esources/[Link]/subscriptions/GP-3333/child/validateSubscription",
"name": "validateSubscription",
"kind": "collection"
},
{
"rel": "action",
"href": "[Link]
esources/[Link]/subscriptions/GP-3333/action/previewSubscriptions",
"name": "previewSubscriptions",
"kind": "other"
},
{
"rel": "action",
"href": "[Link]
esources/[Link]/subscriptions/GP-3333/action/putOnHold",
"name": "putOnHold",
"kind": "other"
},
{
"rel": "action",
"href": "[Link]
esources/[Link]/subscriptions/GP-3333/action/removeHold",
"name": "removeHold",
"kind": "other"
},
{
"rel": "action",
"href": "[Link]
esources/[Link]/subscriptions/GP-3333/action/activate",
"name": "activate",
"kind": "other"
},
{
"rel": "action",
"href": "[Link]
esources/[Link]/subscriptions/GP-3333/action/cancel",
"name": "cancel",
"kind": "other"
},
{
"rel": "action",

30 | P a g e
 Subscription Management REST Documentation

"href": "[Link]
esources/[Link]/subscriptions/GP-3333/action/close",
"name": "close",
"kind": "other"
},
{
"rel": "action",
"href": "[Link]
esources/[Link]/subscriptions/GP-3333/action/renew",
"name": "renew",
"kind": "other"
},
{
"rel": "action",
"href": "[Link]
esources/[Link]/subscriptions/GP-3333/action/raiseUserTransition",
"name": "raiseUserTransition",
"kind": "other"
}
]
}

Update a Subscription

Method: PATCH

URI: /crmRestApi/resources/[Link]/subscriptions/{SubscriptionPUID}

Media Type: application/[Link]+json, application/json

Example:

[Link]
5678

Request Body:

{
"EndDate": "2019-12-25"
}

Response Body:

{
"SubscriptionId": 300100177254423,
"SubscriptionNumber": "GP-5678",
"BusinessUnitId": 204,
"BusinessUnitName": "Vision Operations",
"LegalEntityId": 204,
"LegalEntityName": "Vision Operations",

31 | P a g e
 Subscription Management REST Documentation

"SubscriptionProfileId": 300100172161473,
"SubscriptionProfileName": "zOSS_SP_ServiceStartActual_Advance_Month",
"PrimaryPartyId": 1001,
"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",
"CurrencyName": "US Dollar",
"CurrencyConversionRate": null,
"CurrencyConversionRateType": null,
"CurrencyConversionRateDate": null,
"StartDate": "2019-01-01",
"Duration": 359,
"Period": "DY",
"EndDate": "2019-12-25",
"DefinitionOrganizationId": 204,
"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,
"BillToAccountId": 1001,
"BillToAccountNumber": "1001",
"BillToAccountDescription": "A T & T SOLUTIONS INC",
"BillToSiteUseId": 1006,
"BillToAddress": "32 Ave of the Americas,NEW YORK, NY 10013",
"ShipToParty": null,

32 | P a g e
 Subscription Management REST Documentation

"ShipToPartyName": null,
"ShipToPartySiteId": null,
"ShipToSite": null,
"PaymentMethod": null,
"PaymentMethodName": null,
"PONumber": null,
"WireNumber": null,
"PaymentTermsId": 1064,
"PaymentTermsName": "Immediate",
"TaxClassificationCode": null,
"TaxClassificationMeaning": null,
"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,

33 | P a g e
 Subscription Management REST Documentation

"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:29:14+00:00",
"LastUpdateLogin": "8A5689BEEA6839CBE05322EAF40A0656",
...
}

Delete a Subscription

Method: DELETE

URI: /crmRestApi/resources/[Link]/subscriptions/{SubscriptionPUID}

Media Type: application/[Link]+json, application/json

Example:

[Link]
5678

Response Body:

Blank

Status: 204 No Content

Get a Subscription

Method: GET

URI: /crmRestApi/resources/[Link]/subscriptions/{SubscriptionPUID}

Media Type: application/[Link]+json, application/json

Example:

[Link]
5678

Response Body:

34 | P a g e
 Subscription Management REST Documentation

{
"SubscriptionId": 300100177254423,
"SubscriptionNumber": "GP-5678",
"BusinessUnitId": 204,
"BusinessUnitName": "Vision Operations",
"LegalEntityId": 204,
"LegalEntityName": "Vision Operations",
"SubscriptionProfileId": 300100172161473,
"SubscriptionProfileName": "zOSS_SP_ServiceStartActual_Advance_Month",
"PrimaryPartyId": 1001,
"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",
"CurrencyName": "US Dollar",
"CurrencyConversionRate": null,
"CurrencyConversionRateType": null,
"CurrencyConversionRateDate": null,
"StartDate": "2019-01-01",
"Duration": 359,
"Period": "DY",
"EndDate": "2019-12-25",
"DefinitionOrganizationId": 204,
"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]",

35 | P a g e
 Subscription Management REST Documentation

"CoverageInvoiceText": null,
"BillToAccountId": 1001,
"BillToAccountNumber": "1001",
"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,
"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",

36 | P a g e
 Subscription Management REST Documentation

"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:29:14+00:00",
"LastUpdateLogin": "8A5689BEEA6839CBE05322EAF40A0656",
...
}

Get Subscriptions

Method: GET

URI: /crmRestApi/resources/[Link]/subscriptions

Media Type: application/[Link]+json, application/json

Example:

[Link]

Response Body:

{
"items": [
{
"SubscriptionId": 300100177231447,
"SubscriptionNumber": "CDRM_2",
"BusinessUnitId": 204,
"BusinessUnitName": "Vision Operations",
"LegalEntityId": 204,
"LegalEntityName": "Vision Operations",
"SubscriptionProfileId": 300100172161473,
"SubscriptionProfileName":
"zOSS_SP_ServiceStartActual_Advance_Month",
"PrimaryPartyId": 1006,
"PrimaryPartyName": "Computer Service and Rentals",
"PricedOnDate": "2019-06-03T00:00:00+00:00",
"PricingStrategyId": null,
"PricingStrategyExplanation": null,
"PricingSegment": null,
"PricingSegmentExplanation": null,
"SegmentExplanationMessage": null,

37 | P a g e
 Subscription Management REST Documentation

"Currency": "USD",
"CurrencyName": "US Dollar",
"CurrencyConversionRate": null,
"CurrencyConversionRateType": null,
"CurrencyConversionRateDate": null,
"StartDate": "2019-06-03",
"Duration": 1,
"Period": "0zE",
"EndDate": "2020-06-02",
"DefinitionOrganizationId": 204,
"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,
"BillToAccountId": 1006,
"BillToAccountNumber": "1006",
"BillToAccountDescription": "Computer Service and Rentals",
"BillToSiteUseId": 1025,
"BillToAddress": "301 Summit Hill Drive,CHATTANOOGA, TN 37401",
"ShipToParty": null,
"ShipToPartyName": null,
"ShipToPartySiteId": null,
"ShipToSite": null,
"PaymentMethod": null,
"PaymentMethodName": null,
"PONumber": null,
"WireNumber": null,
"PaymentTermsId": 1064,
"PaymentTermsName": "Immediate",
"TaxClassificationCode": null,

38 | P a g e
 Subscription Management REST Documentation

"TaxClassificationMeaning": null,
"ExemptCertificateNumber": null,
"ExemptReason": null,
"ExemptReasonMeaning": null,
"TaxExemptionHandling": "S",
"TaxExemptionHandlingName": "Standard",
"DocumentFiscalClassification": null,
"CustomerAcceptance": null,
"InternalApproval": "NOTREQUIRED",
"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": 0,
"EstimatedTax": 0,
"CreditedAmount": 0,
"ClosedAmount": 0,
"CanceledAmount": 0,
"InvoicedAmount": 0,
"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-03T16:38:37+00:00",
"LastUpdatedBy": "CONMGR",
"LastUpdateDate": "2019-06-03T16:38:37.560+00:00",
"LastUpdateLogin": "8A568A6CC2BCBE27E05323EAF40A845E",
...
"count": 5,

39 | P a g e
 Subscription Management REST Documentation

"hasMore": false,
"limit": 25,
"offset": 0,
"links": [
{
"rel": "self",
"href":
"[Link]
05/subscriptions",
"name": "subscriptions",
"kind": "collection"
}
]
}

Activate a Subscription (Custom)

Method: POST

URI: /crmRestApi/resources/[Link]/subscriptions/{SubscriptionPUID}

Media Type: application/[Link]+json

Example:

[Link]
M_4

Request Body:

{
"name":"activate"
}

Response Body:

{
"result": "Success"
}

Preview a Subscription (Custom)

Method: POST

URI: /crmRestApi/resources/[Link]/subscriptions/{SubscriptionPUID}

Media Type: application/[Link]+json

40 | P a g e
 Subscription Management REST Documentation

Example:

[Link]
5678

Request Body:

{
"name" : "previewSubscriptions",
"parameters":[

]
}

Response Body:

{
"result": "GP-
[Link],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
 Subscription Management REST Documentation

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
 Subscription Management REST Documentation

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}

Media Type: application/[Link]+json

Example:

[Link]

Request Body:

{
"name": "renew",
"parameters": [
{
"duration": 1
},
{
"period": "0zG"

43 | P a g e
 Subscription Management REST Documentation

},
{
"ignoreWarning": "Y"
}
]
}
Response Body:

{
"result": "CDRM_14"
}

Cancel a Subscription (Custom)

Method: POST

URI: /crmRestApi/resources/latest/subscriptions/{SubscriptionPUID}

Media Type: application/[Link]+json

Example:

[Link]

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
 Subscription Management REST Documentation

URI: /crmRestApi/resources/latest/subscriptions/{SubscriptionPUID}

Media Type: application/[Link]+json

Example:

[Link]

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

URI: /crmRestApi/resources/latest/subscriptions/{SubscriptionPUID}

Media Type: application/[Link]+json

Example:

[Link]

Request Body:

{
"name": "putOnHold"
}

Response Body:

45 | P a g e
 Subscription Management REST Documentation

{
"result": "Success"
}

Remove Hold on a Subscription (Custom)

Method: POST

URI: /crmRestApi/resources/latest/subscriptions/{SubscriptionPUID}

Media Type: application/[Link]+json

Example:

[Link]

Request Body:

{
"name": "removeHold"
}

Response Body:

{
"result": "Success"
}

Subscription Parties
Create a Subscription Party

Method: POST

URI: /crmRestApi/resources/[Link]/subscriptions/{SubscriptionPUID}/child/parties

Media Type: application/[Link]+json, application/json

Example:

[Link]
5678/child/parties

Request Body:

46 | P a g e
 Subscription Management REST Documentation

{
"PartyPuid": "GP-5678-PRTY-24",
"PartyRole": "ORA_CUSTOMER",
"PartyId": 300100070252912,
"PrimaryFlag": false,
"InternalFlag": false
}

Response Body:

{
"SubscriptionPartyId": 300100177241440,
"PartyPuid": "GP-5678-PRTY-24",
"SubscriptionId": 300100177254423,
"PartyRole": "ORA_CUSTOMER",
"PartyId": 300100070252912,
"PrimaryFlag": false,
"InternalFlag": false,
"ObjectVersionNumber": 1,
"CreatedBy": "CONMGR",
"CreationDate": "2019-06-04T18:39:36+00:00",
"LastUpdatedBy": "CONMGR",
"LastUpdateDate": "2019-06-04T18:39:36.173+00:00",
"LastUpdateLogin": "8A5689AE12D939D9E05322EAF40A63A4",
"PartyName": " Clarke James",
"PartyNumber": "CDRM_154814",
...
}

Delete a Subscription Party

Method: DELETE

URI: /crmRestApi/resources/[Link]/subscriptions/{SubscriptionPUID}/child/parties/{PartyPUID}

Media Type: application/[Link]+json, application/json

Example:

[Link]
5678/child/parties/GP-5678-PRTY-20

Response Body:

Blank

Status: 204 No Content

47 | P a g e
 Subscription Management REST Documentation

Get a Subscription Party

Method: GET

URI: /crmRestApi/resources/[Link]/subscriptions/{SubscriptionPUID}/child/parties/{PartyPUID}

Media Type: application/[Link]+json, application/json

Example:

[Link]
5678/child/parties/GP-5678-PRTY-9

Response Body:

{
"SubscriptionPartyId": 300100177254426,
"PartyPuid": "GP-5678-PRTY-9",
"SubscriptionId": 300100177254423,
"PartyRole": "ORA_CUSTOMER",
"PartyId": 1001,
"PrimaryFlag": true,
"InternalFlag": false,
"ObjectVersionNumber": 1,
"CreatedBy": "CONMGR",
"CreationDate": "2019-06-04T04:25:08.026+00:00",
"LastUpdatedBy": "CONMGR",
"LastUpdateDate": "2019-06-04T04:25:08.875+00:00",
"LastUpdateLogin": "8A5689BEEA6839CBE05322EAF40A0656",
"PartyName": "A T & T SOLUTIONS INC",
"PartyNumber": "1001",
...
}

Get Subscription Parties

Method: GET

URI: /crmRestApi/resources/[Link]/subscriptions/{SubscriptionPUID}/child/parties

Media Type: application/[Link]+json, application/json

Example:

[Link]
5678/child/parties

Response Body:

48 | P a g e
 Subscription Management REST Documentation

{
"items": [
{
"SubscriptionPartyId": 300100177254426,
"PartyPuid": "GP-5678-PRTY-9",
"SubscriptionId": 300100177254423,
"PartyRole": "ORA_CUSTOMER",
"PartyId": 1001,
"PrimaryFlag": true,
"InternalFlag": false,
"ObjectVersionNumber": 1,
"CreatedBy": "CONMGR",
"CreationDate": "2019-06-04T04:25:08.026+00:00",
"LastUpdatedBy": "CONMGR",
"LastUpdateDate": "2019-06-04T04:25:08.875+00:00",
"LastUpdateLogin": "8A5689BEEA6839CBE05322EAF40A0656",
"PartyName": "A T & T SOLUTIONS INC",
"PartyNumber": "1001",
...
},
{
"SubscriptionPartyId": 300100177254427,
"PartyPuid": "GP-5678-PRTY-10",
"SubscriptionId": 300100177254423,
"PartyRole": "ORA_VENDOR",
"PartyId": 204,
"PrimaryFlag": false,
"InternalFlag": true,
"ObjectVersionNumber": 1,
"CreatedBy": "CONMGR",
"CreationDate": "2019-06-04T04:25:08.037+00:00",
"LastUpdatedBy": "CONMGR",
"LastUpdateDate": "2019-06-04T04:25:08.882+00:00",
"LastUpdateLogin": "8A5689BEEA6839CBE05322EAF40A0656",
"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
 Subscription Management REST Documentation

URI:
/crmRestApi/resources/[Link]/subscriptions/{SubscriptionPUID}/child/parties/{PartyPUID}/child/c
ontacts

Media Type: application/[Link]+json, application/json

Example:

[Link]
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,
"InternalFlag": false
}

Response Body:

{
"SubscriptionContactId": 300100177241556,
"ContactPuid": "GP-5678-PRTY-9-PCNT-10",
"SubscriptionPartyId": 300100177254426,
"ContactRole": "ORA_CUSTOMER_CONTACT",
"SubscriptionId": 300100177254423,
"PartyId": 1001,
"ContactId": 1009,
"StartDate": null,
"EndDate": null,
"AccessLevel": null,
"BillingOwnerFlag": false,
"InternalFlag": false,
"ContactName": "Mike Kenton",
"ContactEmail": null,
"ObjectVersionNumber": 1,
"CreatedBy": "CONMGR",
"CreationDate": "2019-06-05T03:14:40+00:00",
"LastUpdatedBy": "CONMGR",
"LastUpdateDate": "2019-06-05T03:14:40.329+00:00",
"LastUpdateLogin": "8A5689AE12D939D9E05322EAF40A63A4",
...
}

For creating a team member:

{
"ContactPuid": "GP-5678-PRTY-10-PCNT-2",
"ContactRole": "ORA_RESOURCE",

50 | P a g e
 Subscription Management REST Documentation

"ContactId": 6318,
"BillingOwnerFlag": false,
"InternalFlag": false
}

Delete a Subscription Party Contact

Method: DELETE

URI:
/crmRestApi/resources/[Link]/subscriptions/{SubscriptionPUID}/child/parties/{PartyPUID}/child/c
ontacts/{ContactPUID}

Media Type: application/[Link]+json, application/json

Example:

[Link]
5678/child/parties/GP-5678-PRTY-9/child/contacts/GP-5678-PRTY-9-PCNT-10

Response Body:

Blank

Status: 204 No Content

Get a Subscription Party Contact

Method: GET

URI:
/crmRestApi/resources/[Link]/subscriptions/{SubscriptionPUID}/child/parties/{PartyPUID}/child/c
ontacts/{ContactPUID}

Media Type: application/[Link]+json, application/json

Example:

[Link]
5678/child/parties/GP-5678-PRTY-9/child/contacts/GP-5678-PRTY-9-PCNT-10

Response Body:

51 | P a g e
 Subscription Management REST Documentation

{
"SubscriptionContactId": 300100177231590,
"ContactPuid": "GP-5678-PRTY-9-PCNT-10",
"SubscriptionPartyId": 300100177254426,
"ContactRole": "ORA_CUSTOMER_CONTACT",
"SubscriptionId": 300100177254423,
"PartyId": 1001,
"ContactId": 1009,
"StartDate": null,
"EndDate": null,
"AccessLevel": null,
"BillingOwnerFlag": false,
"InternalFlag": false,
"ContactName": "Mike Kenton",
"ContactEmail": null,
"ObjectVersionNumber": 1,
"CreatedBy": "CONMGR",
"CreationDate": "2019-06-04T18:24:30.391+00:00",
"LastUpdatedBy": "CONMGR",
"LastUpdateDate": "2019-06-04T18:24:39.925+00:00",
"LastUpdateLogin": "8A568A7FD0B9BE1EE05323EAF40A0287",
...
}

Get Subscription Party Contacts

Method: GET

URI:
/crmRestApi/resources/[Link]/subscriptions/{SubscriptionPUID}/child/parties/{PartyPUID}/child/c
ontacts

Media Type: application/[Link]+json, application/json

Example:

[Link]
5678/child/parties/GP-5678-PRTY-9/child/contacts

Response Body:

{
"items": [
{
"SubscriptionContactId": 300100177231590,
"ContactPuid": "GP-5678-PRTY-9-PCNT-10",
"SubscriptionPartyId": 300100177254426,
"ContactRole": "ORA_CUSTOMER_CONTACT",
"SubscriptionId": 300100177254423,
"PartyId": 1001,
"ContactId": 1009,

52 | P a g e
 Subscription Management REST Documentation

"StartDate": null,
"EndDate": null,
"AccessLevel": null,
"BillingOwnerFlag": false,
"InternalFlag": false,
"ContactName": "Mike Kenton",
"ContactEmail": null,
"ObjectVersionNumber": 1,
"CreatedBy": "CONMGR",
"CreationDate": "2019-06-04T18:24:30.391+00:00",
"LastUpdatedBy": "CONMGR",
"LastUpdateDate": "2019-06-04T18:24:39.925+00:00",
"LastUpdateLogin": "8A568A7FD0B9BE1EE05323EAF40A0287",
...
}
],
"count": 1,
"hasMore": false,
"limit": 25,
"offset": 0,
...
}

Subscription Sales Credits

Create a Subscription Sales Credit

Method: POST

URI: /crmRestApi/resources/[Link]/subscriptions/{SubscriptionPUID}/child/salesCredits

Media Type: application/[Link]+json, application/json

Example:

[Link]
5678/child/salesCredits

Request Body:

{
"SalesCreditPuid": "GP-5678-SLCR-1",
"SalesCreditTypeId": 1,
"SalesrepId": 100000008147775,
"Percentage": 100
}

Response Body:

53 | P a g e
 Subscription Management REST Documentation

"CreatedBy": "CONMGR",
"CreationDate": "2019-06-05T03:41:58+00:00",
"EndDate": null,
"LastUpdateDate": "2019-06-05T03:41:58.288+00:00",
"LastUpdateLogin": "8A5689AE12D939D9E05322EAF40A63A4",
"LastUpdatedBy": "CONMGR",
"Percentage": 100,
"SalesCreditId": 300100177254595,
"SalesCreditPuid": "GP-5678-SLCR-1",
"SalesCreditTypeId": 1,
"SalesrepId": 100000008147775,
"StartDate": null,
"SubscriptionId": 300100177254423,
"SubscriptionProductId": null,
"SalesPerson": "Abhijit Chan",
"SalesCreditType": "Quota Sales Credit",
"QuotaFlag": true,
...
}

Update a Subscription Sales Credit

Method: PATCH

URI:
/crmRestApi/resources/[Link]/subscriptions/{SubscriptionPUID}/child/salesCredits/{SalesCreditPU
ID}

Media Type: application/[Link]+json, application/json

Example:

[Link]
5678/child/salesCredits/GP-5678-SLCR-9

Request Body:

{
"Percentage": 70
}

Response Body:

{
"CreatedBy": "CONMGR",
"CreationDate": "2019-06-05T04:16:57.173+00:00",
"EndDate": null,
"LastUpdateDate": "2019-06-05T04:17:38.006+00:00",
"LastUpdateLogin": "8A5689AE12D939D9E05322EAF40A63A4",
"LastUpdatedBy": "CONMGR",

54 | P a g e
 Subscription Management REST Documentation

"Percentage": 70,
"SalesCreditId": 300100177232435,
"SalesCreditPuid": "GP-5678-SLCR-9",
"SalesCreditTypeId": 2,
"SalesrepId": 100000000177813,
"StartDate": null,
"SubscriptionId": 300100177254423,
"SubscriptionProductId": null,
"SalesPerson": "Aaron Wang",
"SalesCreditType": "Non-quota Sales Credit",
"QuotaFlag": false,
...
}

Delete a Subscription Sales Credit

Method: DELETE

URI:
/crmRestApi/resources/[Link]/subscriptions/{SubscriptionPUID}/child/salesCredits/{SalesCreditPU
ID}

Media Type: application/[Link]+json, application/json

Example:

[Link]
5678/child/salesCredits/GP-5678-SLCR-1

Response Body:

Blank

Status: 204 No Content

Get a Subscription Sales Credit

Method: GET

URI:
/crmRestApi/resources/[Link]/subscriptions/{SubscriptionPUID}/child/salesCredits/{SalesCreditPU
ID}

Media Type: application/[Link]+json, application/json

Example:

55 | P a g e
 Subscription Management REST Documentation

[Link]
5678/child/salesCredits/GP-5678-SLCR-1

Response Body:

{
"CreatedBy": "CONMGR",
"CreationDate": "2019-06-05T03:18:51+00:00",
"EndDate": null,
"LastUpdateDate": "2019-06-05T03:19:28.334+00:00",
"LastUpdateLogin": "8A568ABC72F139D7E05322EAF40A0F90",
"LastUpdatedBy": "CONMGR",
"Percentage": 50,
"SalesCreditId": 300100177232427,
"SalesCreditPuid": "GP-5678-SLCR-1",
"SalesCreditTypeId": 1,
"SalesrepId": 100000008147775,
"StartDate": null,
"SubscriptionId": 300100177254423,
"SubscriptionProductId": null,
"SalesPerson": "Abhijit Chan",
"SalesCreditType": "Quota Sales Credit",
"QuotaFlag": true,
...
}

Get Subscription Sales Credits

Method: GET

URI: /crmRestApi/resources/[Link]/subscriptions/{SubscriptionPUID}/child/salesCredits

Media Type: application/[Link]+json, application/json

Example:

[Link]
5678/child/salesCredits

Response Body:

{
"items": [
{
"CreatedBy": "CONMGR",
"CreationDate": "2019-06-05T03:18:51+00:00",
"EndDate": null,
"LastUpdateDate": "2019-06-05T03:19:28.334+00:00",
"LastUpdateLogin": "8A568ABC72F139D7E05322EAF40A0F90",
"LastUpdatedBy": "CONMGR",

56 | P a g e
 Subscription Management REST Documentation

"Percentage": 50,
"SalesCreditId": 300100177232427,
"SalesCreditPuid": "GP-5678-SLCR-1",
"SalesCreditTypeId": 1,
"SalesrepId": 100000008147775,
"StartDate": null,
"SubscriptionId": 300100177254423,
"SubscriptionProductId": null,
"SalesPerson": "Abhijit Chan",
"SalesCreditType": "Quota Sales Credit",
"QuotaFlag": true,
...
},
{
"CreatedBy": "CONMGR",
"CreationDate": "2019-06-05T03:19:10.228+00:00",
"EndDate": null,
"LastUpdateDate": "2019-06-05T03:19:28.424+00:00",
"LastUpdateLogin": "8A568ABC72F139D7E05322EAF40A0F90",
"LastUpdatedBy": "CONMGR",
"Percentage": 50,
"SalesCreditId": 300100177232428,
"SalesCreditPuid": "GP-5678-SLCR-2",
"SalesCreditTypeId": 1,
"SalesrepId": 100000008143794,
"StartDate": null,
"SubscriptionId": 300100177254423,
"SubscriptionProductId": null,
"SalesPerson": "Alain Berthier",
"SalesCreditType": "Quota Sales Credit",
"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/

Media Type: application/[Link]+json, application/json

57 | P a g e
 Subscription Management REST Documentation

Example:

[Link]
5678/child/products/

Request Body:

{
"LineNumber": "1",
"SubscriptionProductPuid": "GP-5678-PRDT-1",
"DefinitionOrganizationId": 204,
"SalesProductType": "SUBSCRIPTION",
"Description": "QP Item for SPT Subscription",
"InventoryItemId": 300100012368232,
"ItemUnitOfMeasure": "Ea",
"ProductName": "QP_Item3",
"Quantity": 1,
"StartDate": "2019-01-01",
"EndDate": "2019-12-25"
}

Response Body:

{
"SubscriptionProductId": 300100177254429,
"SubscriptionId": 300100177254423,
"LineNumber": "1",
"SubscriptionProductPuid": "GP-5678-PRDT-1",
"DefinitionOrganizationId": 204,
"SubscriptionNumber": "GP-5678",
"SalesProductType": "SUBSCRIPTION",
"Description": "QP Item for SPT Subscription",
"InventoryItemId": 300100012368232,
"ItemUnitOfMeasure": "Ea",
"ProductName": "QP_Item3",
"Quantity": 1,
"StartDate": "2019-01-01",
"EndDate": "2019-12-25",
"CloseReason": null,
"CloseCreditMethod": null,
"CancelReason": null,
"ClosedDate": null,
"CanceledDate": null,
"RenewedDate": null,
"PriceListId": null,
"UnitPrice": null,
"Status": "ORA_DRAFT",
"Currency": "USD",
"InvoicingRuleId": -2,
"InvoicingRuleName": "Advance Invoice",
"BillOnDay": null,
"BillingOffsetDays": null,
"BillingFrequency": "0zG",
"BillingFrequencyName": "MONTH",
"AccountingRuleId": 300100033038413,

58 | P a g e
 Subscription Management REST Documentation

"AccountingRuleName": "3 Months, Deferred",

"TransactionTypeName": "ORA_OSS_Invoice",
"InvoiceText": "[$Item Name]: [$Charge Name] [$Bill from Date]-[$Bill to
Date]",
"BillToAccountId": 1001,
"BillToAccountNumber": "1001",
"BillToAccountDescription": "A T & T SOLUTIONS INC",
"BillToSiteUseId": 1006,
"BillToAddress": "32 Ave of the Americas,NEW YORK, NY 10013",
"ShipToPartyId": null,
"ShipToPartyName": null,
"ShipToPartySiteId": null,
"ShipToPartySiteName": null,
"PaymentMethod": null,
"PaymentMethodName": null,
"PONumber": null,
"WireNumber": null,
"PaymentTermsId": 1064,
"PaymentTermsName": "Immediate",
"PrePaymentNumber": null,
"TaxExemptionHandling": "S",
"TaxExemptionHandlingName": "Standard",
"ExemptCertificateNumber": null,
"ExemptReason": null,
"OutputTaxClassification": null,
"ProductFiscClassification": null,
"TaxError": null,
"CoverageScheduleId": null,
"RenewalType": "RENEW",
"BillingDateCode": "ORA_PERIOD_START",
"BillingDateName": "Period start",
"TotalContractValue": null,
"EstimatedTax": null,
"PricingError": null,
"PriceAsOf": "2019-06-04",
"PriceTransactionOn": "2019-06-04",
"InvoicedAmount": null,
"CreditedAmount": null,
"CanceledAmount": null,
"ClosedAmount": null,
"SourceSystem": null,
"SourceKey": null,
"SourceNumber": null,
"SourceLineKey": null,
"SourceLineNumber": null,
"MonthlyRecurringRevenue": null,
"Duration": 359,
"Period": "DY",
"GenerateBillingSchedule": null,
"ExternalAssetKey": null,
"ExternalParentAssetKey": null,
"ExternalPriceListId": null,
"ExternalRootAssetKey": null,
"PriceListName": null,
"NextPricingDate": null,
"PricingTermsStartDate": null,
"PricingTermsPricingMethod": null,

59 | P a g e
 Subscription Management REST Documentation

"PricingTermsPeriod": null,
"PricingTermsDuration": null,
"PricingTermsAdjustmentPCT": null,
"CorpCurrencyCode": "USD",
"CurcyConvRateType": "Corporate",
"AmendCreditMethod": null,
"AmendCreditMethodName": null,
"AmendDescription": null,
"AmendEffectiveDate": null,
"AmendReason": null,
"AmendReasonName": null,
"StatusMeaning": "Draft",
"EnablePricingTermsFlag": null,
"TaxClassificationMeaning": null,
"CreatedBy": "CONMGR",
"CreationDate": "2019-06-04T05:18:01+00:00",
"LastUpdatedBy": "CONMGR",
"LastUpdateDate": "2019-06-04T05:18:02.375+00:00",
"LastUpdateLogin": "8A5689BEEA6839CBE05322EAF40A0656",
"SummarizedBillingFlag": null,
"InterfaceOffsetDays": null,
"CoverageName": null,
...
}

Update a Subscription Product

Method: PATCH

URI:
/crmRestApi/resources/[Link]/subscriptions/{SubscriptionPUID}/child/products/{SubscriptionProd
uctPUID}

Media Type: application/[Link]+json, application/json

Example:

[Link]
5678/child/products/GP-5678-PRDT-1

Request Body:

{
"EndDate": "2019-12-20"
}

Response Body:

{
"SubscriptionProductId": 300100177254429,

60 | P a g e
 Subscription Management REST Documentation

"SubscriptionId": 300100177254423,
"LineNumber": "1",
"SubscriptionProductPuid": "GP-5678-PRDT-1",
"DefinitionOrganizationId": 204,
"SubscriptionNumber": "GP-5678",
"SalesProductType": "SUBSCRIPTION",
"Description": "QP Item for SPT Subscription",
"InventoryItemId": 300100012368232,
"ItemUnitOfMeasure": "Ea",
"ProductName": "QP_Item3",
"Quantity": 1,
"StartDate": "2019-01-01",
"EndDate": "2019-12-20",
"CloseReason": null,
"CloseCreditMethod": null,
"CancelReason": null,
"ClosedDate": null,
"CanceledDate": null,
"RenewedDate": null,
"PriceListId": null,
"UnitPrice": null,
"Status": "ORA_DRAFT",
"Currency": "USD",
"InvoicingRuleId": -2,
"InvoicingRuleName": "Advance Invoice",
"BillOnDay": null,
"BillingOffsetDays": null,
"BillingFrequency": "0zG",
"BillingFrequencyName": "MONTH",
"AccountingRuleId": 300100033038413,
"AccountingRuleName": "3 Months, Deferred",
"TransactionTypeName": "ORA_OSS_Invoice",
"InvoiceText": "[$Item Name]: [$Charge Name] [$Bill from Date]-[$Bill to
Date]",
"BillToAccountId": 1001,
"BillToAccountNumber": "1001",
"BillToAccountDescription": "A T & T SOLUTIONS INC",
"BillToSiteUseId": 1006,
"BillToAddress": "32 Ave of the Americas,NEW YORK, NY 10013",
"ShipToPartyId": null,
"ShipToPartyName": null,
"ShipToPartySiteId": null,
"ShipToPartySiteName": null,
"PaymentMethod": null,
"PaymentMethodName": null,
"PONumber": null,
"WireNumber": null,
"PaymentTermsId": 1064,
"PaymentTermsName": "Immediate",
"PrePaymentNumber": null,
"TaxExemptionHandling": "S",
"TaxExemptionHandlingName": "Standard",
"ExemptCertificateNumber": null,
"ExemptReason": null,
"OutputTaxClassification": null,
"ProductFiscClassification": null,
"TaxError": null,

61 | P a g e
 Subscription Management REST Documentation

"CoverageScheduleId": null,
"RenewalType": "RENEW",
"BillingDateCode": "ORA_PERIOD_START",
"BillingDateName": "Period start",
"TotalContractValue": null,
"EstimatedTax": null,
"PricingError": null,
"PriceAsOf": "2019-06-04",
"PriceTransactionOn": "2019-06-04",
"InvoicedAmount": null,
"CreditedAmount": null,
"CanceledAmount": null,
"ClosedAmount": null,
"SourceSystem": null,
"SourceKey": null,
"SourceNumber": null,
"SourceLineKey": null,
"SourceLineNumber": null,
"MonthlyRecurringRevenue": null,
"Duration": 354,
"Period": "DY",
"GenerateBillingSchedule": null,
"ExternalAssetKey": null,
"ExternalParentAssetKey": null,
"ExternalPriceListId": null,
"ExternalRootAssetKey": null,
"PriceListName": null,
"NextPricingDate": null,
"PricingTermsStartDate": null,
"PricingTermsPricingMethod": null,
"PricingTermsPeriod": null,
"PricingTermsDuration": null,
"PricingTermsAdjustmentPCT": null,
"CorpCurrencyCode": "USD",
"CurcyConvRateType": "Corporate",
"AmendCreditMethod": null,
"AmendCreditMethodName": null,
"AmendDescription": null,
"AmendEffectiveDate": null,
"AmendReason": null,
"AmendReasonName": null,
"StatusMeaning": "Draft",
"EnablePricingTermsFlag": null,
"TaxClassificationMeaning": null,
"CreatedBy": "CONMGR",
"CreationDate": "2019-06-04T05:18:01+00:00",
"LastUpdatedBy": "CONMGR",
"LastUpdateDate": "2019-06-04T05:18:02.375+00:00",
"LastUpdateLogin": "8A5689BEEA6839CBE05322EAF40A0656",
"SummarizedBillingFlag": null,
"InterfaceOffsetDays": null,
"CoverageName": null,
...
}

62 | P a g e
 Subscription Management REST Documentation

Delete a Subscription Product

Method: DELETE

URI:
/crmRestApi/resources/[Link]/subscriptions/{SubscriptionPUID}/child/products/{SubscriptionProd
uctPUID}

Media Type: application/[Link]+json, application/json

Example:

[Link]
hild/products/CDRM_1-PRDT-1

Response Body:

Blank

Status: 204 No Content

Get a Subscription Product

Method: GET

URI:
/crmRestApi/resources/[Link]/subscriptions/{SubscriptionPUID}/child/products/{SubscriptionProd
uctPUID}

Media Type: application/[Link]+json, application/json

Example:

[Link]
hild/products/CDRM_1-PRDT-1

Response Body:

{
"SubscriptionProductId": 300100177231436,
"SubscriptionId": 300100177231430,
"LineNumber": "1",
"SubscriptionProductPuid": "CDRM_1-PRDT-1",
"DefinitionOrganizationId": 204,
"SubscriptionNumber": "CDRM_1",

63 | P a g e
 Subscription Management REST Documentation

"SalesProductType": "SUBSCRIPTION",
"Description": "QP Item for SPT Subscription",
"InventoryItemId": 300100012368232,
"ItemUnitOfMeasure": "Ea",
"ProductName": "QP_Item3",
"Quantity": 1,
"StartDate": "2019-06-03",
"EndDate": "2020-06-02",
"CloseReason": "ORA_NON_COMPLIANCE",
"CloseCreditMethod": "ORA_FULL",
"CancelReason": null,
"ClosedDate": "2019-06-08",
"CanceledDate": null,
"RenewedDate": null,
"PriceListId": 300100071623855,
"UnitPrice": null,
"Status": "ORA_ACTIVE",
"Currency": "USD",
"InvoicingRuleId": -2,
"InvoicingRuleName": "Advance Invoice",
"BillOnDay": null,
"BillingOffsetDays": null,
"BillingFrequency": "0zG",
"BillingFrequencyName": "MONTH",
"AccountingRuleId": 300100033038413,
"AccountingRuleName": "3 Months, Deferred",
"TransactionTypeName": "ORA_OSS_Invoice",
"InvoiceText": "[$Item Name]: [$Charge Name] [$Bill from Date]-[$Bill to
Date]",
"BillToAccountId": 1006,
"BillToAccountNumber": "1006",
"BillToAccountDescription": "Computer Service and Rentals",
"BillToSiteUseId": 1025,
"BillToAddress": "301 Summit Hill Drive,CHATTANOOGA, TN 37401",
"ShipToPartyId": null,
"ShipToPartyName": null,
"ShipToPartySiteId": null,
"ShipToPartySiteName": null,
"PaymentMethod": null,
"PaymentMethodName": null,
"PONumber": null,
"WireNumber": null,
"PaymentTermsId": 1064,
"PaymentTermsName": "Immediate",
"PrePaymentNumber": null,
"TaxExemptionHandling": "S",
"TaxExemptionHandlingName": "Standard",
"ExemptCertificateNumber": null,
"ExemptReason": null,
"OutputTaxClassification": null,
"ProductFiscClassification": null,
"TaxError": null,
"CoverageScheduleId": null,
"RenewalType": "RENEW",
"BillingDateCode": "ORA_PERIOD_START",
"BillingDateName": "Period start",
"TotalContractValue": 0,

64 | P a g e
 Subscription Management REST Documentation

"EstimatedTax": 4820,
"PricingError": null,
"PriceAsOf": "2019-06-03",
"PriceTransactionOn": "2019-06-03",
"InvoicedAmount": null,
"CreditedAmount": 0,
"CanceledAmount": null,
"ClosedAmount": 24100,
"SourceSystem": null,
"SourceKey": null,
"SourceNumber": null,
"SourceLineKey": null,
"SourceLineNumber": null,
"MonthlyRecurringRevenue": 2000,
"Duration": 1,
"Period": "0zE",
"GenerateBillingSchedule": null,
"ExternalAssetKey": null,
"ExternalParentAssetKey": null,
"ExternalPriceListId": null,
"ExternalRootAssetKey": null,
"PriceListName": null,
"NextPricingDate": null,
"PricingTermsStartDate": null,
"PricingTermsPricingMethod": null,
"PricingTermsPeriod": null,
"PricingTermsDuration": null,
"PricingTermsAdjustmentPCT": null,
"CorpCurrencyCode": "USD",
"CurcyConvRateType": "Corporate",
"AmendCreditMethod": null,
"AmendCreditMethodName": null,
"AmendDescription": null,
"AmendEffectiveDate": null,
"AmendReason": null,
"AmendReasonName": null,
"StatusMeaning": "Active",
"EnablePricingTermsFlag": null,
"TaxClassificationMeaning": null,
"CreatedBy": "CONMGR",
"CreationDate": "2019-06-03T16:13:44.944+00:00",
"LastUpdatedBy": "CONMGR",
"LastUpdateDate": "2019-06-03T16:14:36.398+00:00",
"LastUpdateLogin": "8A568A6CC2BCBE27E05323EAF40A845E",
"SummarizedBillingFlag": null,
"InterfaceOffsetDays": null,
"CoverageName": null,
...
}

Get Subscription Products

Method: GET

65 | P a g e
 Subscription Management REST Documentation

URI: /crmRestApi/resources/[Link]/subscriptions/{SubscriptionPUID}/child/products

Media Type: application/[Link]+json, application/json

Example:

[Link]
hild/products

Response Body:

{
"items": [
{
"SubscriptionProductId": 300100177254429,
"SubscriptionId": 300100177254423,
"LineNumber": "1",
"SubscriptionProductPuid": "GP-5678-PRDT-1",
"DefinitionOrganizationId": 204,
"SubscriptionNumber": "GP-5678",
"SalesProductType": "SUBSCRIPTION",
"Description": "QP Item for SPT Subscription",
"InventoryItemId": 300100012368232,
"ItemUnitOfMeasure": "Ea",
"ProductName": "QP_Item3",
"Quantity": 1,
"StartDate": "2019-01-01",
"EndDate": "2019-12-25",
"CloseReason": null,
"CloseCreditMethod": null,
"CancelReason": null,
"ClosedDate": null,
"CanceledDate": null,
"RenewedDate": null,
"PriceListId": null,
"UnitPrice": null,
"Status": "ORA_DRAFT",
"Currency": "USD",
"InvoicingRuleId": -2,
"InvoicingRuleName": "Advance Invoice",
"BillOnDay": null,
"BillingOffsetDays": null,
"BillingFrequency": "0zG",
"BillingFrequencyName": "MONTH",
"AccountingRuleId": 300100033038413,
"AccountingRuleName": "3 Months, Deferred",
"TransactionTypeName": "ORA_OSS_Invoice",
"InvoiceText": "[$Item Name]: [$Charge Name] [$Bill from Date]-
[$Bill to Date]",
"BillToAccountId": 1001,
"BillToAccountNumber": "1001",
"BillToAccountDescription": "A T & T SOLUTIONS INC",
"BillToSiteUseId": 1006,
"BillToAddress": "32 Ave of the Americas,NEW YORK, NY 10013",
"ShipToPartyId": null,

66 | P a g e
 Subscription Management REST Documentation

"ShipToPartyName": null,
"ShipToPartySiteId": null,
"ShipToPartySiteName": null,
"PaymentMethod": null,
"PaymentMethodName": null,
"PONumber": null,
"WireNumber": null,
"PaymentTermsId": 1064,
"PaymentTermsName": "Immediate",
"PrePaymentNumber": null,
"TaxExemptionHandling": "S",
"TaxExemptionHandlingName": "Standard",
"ExemptCertificateNumber": null,
"ExemptReason": null,
"OutputTaxClassification": null,
"ProductFiscClassification": null,
"TaxError": null,
"CoverageScheduleId": null,
"RenewalType": "RENEW",
"BillingDateCode": "ORA_PERIOD_START",
"BillingDateName": "Period start",
"TotalContractValue": null,
"EstimatedTax": null,
"PricingError": null,
"PriceAsOf": "2019-06-04",
"PriceTransactionOn": "2019-06-04",
"InvoicedAmount": null,
"CreditedAmount": null,
"CanceledAmount": null,
"ClosedAmount": null,
"SourceSystem": null,
"SourceKey": null,
"SourceNumber": null,
"SourceLineKey": null,
"SourceLineNumber": null,
"MonthlyRecurringRevenue": null,
"Duration": 359,
"Period": "DY",
"GenerateBillingSchedule": null,
"ExternalAssetKey": null,
"ExternalParentAssetKey": null,
"ExternalPriceListId": null,
"ExternalRootAssetKey": null,
"PriceListName": null,
"NextPricingDate": null,
"PricingTermsStartDate": null,
"PricingTermsPricingMethod": null,
"PricingTermsPeriod": null,
"PricingTermsDuration": null,
"PricingTermsAdjustmentPCT": null,
"CorpCurrencyCode": "USD",
"CurcyConvRateType": "Corporate",
"AmendCreditMethod": null,
"AmendCreditMethodName": null,
"AmendDescription": null,
"AmendEffectiveDate": null,
"AmendReason": null,

67 | P a g e
 Subscription Management REST Documentation

"AmendReasonName": null,
"StatusMeaning": "Draft",
"EnablePricingTermsFlag": null,
"TaxClassificationMeaning": null,
"CreatedBy": "CONMGR",
"CreationDate": "2019-06-04T05:18:01+00:00",
"LastUpdatedBy": "CONMGR",
"LastUpdateDate": "2019-06-04T05:18:02.375+00:00",
"LastUpdateLogin": "8A5689BEEA6839CBE05322EAF40A0656",
"SummarizedBillingFlag": null,
"InterfaceOffsetDays": null,
"CoverageName": null,
...
"count": 1,
"hasMore": false,
"limit": 25,
"offset": 0,
"links": [
{
"rel": "self",
"href":
"[Link]
05/subscriptions/GP-5678/child/products",
"name": "products",
"kind": "collection"
}
]
}

Cancel a Subscription Product (Custom)

Method: POST

URI: /crmRestApi/resources/latest/subscriptionProducts/{SubscriptionProductPUID}

Media Type: application/[Link]+json

Example:

[Link]
RM_2-PRDT-1

Request Body:

{
"name":"cancel",
"parameters":[
{
"cancelReason":"ORA_PRICING"
},
{
"canceledDate":"2019-06-03"

68 | P a g e
 Subscription Management REST Documentation

}
]
}

Response Body:

{
"result": "Success"
}

Close a Subscription Product (Custom)

Method: POST

URI: /crmRestApi/resources/latest/subscriptionProducts/{SubscriptionProductPUID}

Media Type: application/[Link]+json

Example:

[Link]
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
 Subscription Management REST Documentation

Method: POST

URI: /crmRestApi/resources/latest/subscriptionProducts/{SubscriptionProductPUID}

Media Type: application/[Link]+json

Example:

[Link]
RM_2-PRDT-1

Request Body:

{
"name": "putOnHold"
}

Response Body:

{
"result": "Success"
}

Remove Hold on a Subscription Product (Custom)

Method: POST

URI: /crmRestApi/resources/latest/subscriptionProducts/{SubscriptionProductPUID}

Media Type: application/[Link]+json

Example:

[Link]
RM_2-PRDT-1

Request Body:

{
"name": "removeHold"
}

Response Body:

{
"result": "Success"
}

70 | P a g e
 Subscription Management REST Documentation

Suspend a Subscription Product (Custom)

Method: POST

URI: /crmRestApi/resources/latest/subscriptionProducts/{SubscriptionProductPUID}

Media Type: application/[Link]+json

Example:

[Link]
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

URI: /crmRestApi/resources/latest/subscriptionProducts/{SubscriptionProductPUID}

Media Type: application/[Link]+json

Example:

[Link]
RM_2-PRDT-1

71 | P a g e
 Subscription Management REST Documentation

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:
/crmRestApi/resources/[Link]/subscriptions/{SubscriptionPUID}/child/products/{SubscriptionProd
uctPUID}/child/coveredLevels

Media Type: application/[Link]+json, application/json

Example:

72 | P a g e
 Subscription Management REST Documentation

[Link]
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.

[Link]
s/GP-5678-PRDT-7/child/coveredLevels

Request Body:

{
"CoveredLevelPuid": "GP-5678-PRDT-7-PASS-1",
"LineNumber": "1",
"InventoryItemId": 300100118490672,
"AssetId": 300100118585763,
"AssetName": "zOKC_Auto_Asset1",
"ProductName": "ZOKC_Item_001",
"Description": "Item",
"Type": "ORA_ASSET",
"Quantity": 1,
"ItemUnitOfMeasure": "Ea",
"TotalContractValue": 12361.29,
"EndDate": "2019-12-25",
"StartDate": "2019-01-01",
"PriceAsOf": "2019-01-01",
"PriceUnitOfMeasure": "0zE"
}

Response Body:

{
"CoveredLevelId": 300100177254431,
"CoveredLevelPuid": "GP-5678-PRDT-7-PASS-1",
"SubscriptionProductId": 300100177231547,
"SubscriptionId": 300100177254423,
"LineNumber": "1",
"InventoryItemId": 300100118490672,
"AssetId": 300100118585763,
"AssetName": "zOKC_Auto_Asset1",
"AssetSerialNumber": null,
"ProductName": "ZOKC_Item_001",
"Description": "Item",
"Type": "ORA_ASSET",
"TypeName": "Asset",
"Quantity": 1,
"ItemUnitOfMeasure": "Ea",
"TotalContractValue": 12361.29,
"GenerateBillingSchedule": null,
"EndDate": "2019-12-25",
"StartDate": "2019-01-01",
"Duration": 359,
"Period": "DY",
"Status": "ORA_DRAFT",

73 | P a g e
 Subscription Management REST Documentation

"StatusName": "Draft",
"PriceAsOf": "2019-01-01",
"PriceUnitOfMeasure": "0zE",
"PriceUnitOfMeasureName": "YEAR",
"PriceListId": null,
"PricingError": null,
"TaxAmount": null,
"InvoiceText": null,
"CancelReason": null,
"CanceledDate": null,
"CanceledAmount": null,
"ClosedDate": null,
"CloseReason": null,
"ClosedAmount": null,
"ReturnCreditMethod": null,
"SuppressedCreditAmount": null,
"InvoicedAmount": null,
"CreditedAmount": null,
"RenewedDate": null,
"RenewalType": null,
"TaxError": null,
"CreatedBy": "CONMGR",
"CreationDate": "2019-06-04T18:08:34+00:00",
"LastUpdatedBy": "CONMGR",
"LastUpdateDate": "2019-06-04T18:08:38.099+00:00",
"LastUpdateLogin": "8A5689AE12D939D9E05322EAF40A63A4",
"CurrencyCode": null,
"CorpCurrencyCode": null,
"CurcyConvRateType": null,
"PutOnHoldFlag": null,
"RemoveHoldFlag": null,
...
}

Update a Subscription Product Covered Level

Method: PATCH

URI:
/crmRestApi/resources/[Link]/subscriptions/{SubscriptionPUID}/child/products/{SubscriptionProd
uctPUID}/child/coveredLevels/{SubscriptionCoveredLevelPUID}

Media Type: application/[Link]+json, application/json

Example:

[Link]
5678/child/products/GP-5678-PRDT-7/child/coveredLevels/GP-5678-PRDT-7-PASS-1

Request Body:

74 | P a g e
 Subscription Management REST Documentation

{
"Quantity": 2,
"EndDate": "2019-12-26"
}

Response Body:

{
"CoveredLevelId": 300100177254431,
"CoveredLevelPuid": "GP-5678-PRDT-7-PASS-1",
"SubscriptionProductId": 300100177231547,
"SubscriptionId": 300100177254423,
"LineNumber": "1",
"InventoryItemId": 300100118490672,
"AssetId": 300100118585763,
"AssetName": "zOKC_Auto_Asset1",
"AssetSerialNumber": null,
"ProductName": "ZOKC_Item_001",
"Description": "Item",
"Type": "ORA_ASSET",
"TypeName": "Asset",
"Quantity": 1,
"ItemUnitOfMeasure": "Ea",
"TotalContractValue": 12361.29,
"GenerateBillingSchedule": null,
"EndDate": "2019-12-26",
"StartDate": "2019-01-01",
"Duration": 360,
"Period": "DY",
"Status": "ORA_DRAFT",
"StatusName": "Draft",
"PriceAsOf": "2019-01-01",
"PriceUnitOfMeasure": "0zE",
"PriceUnitOfMeasureName": "YEAR",
"PriceListId": null,
"PricingError": null,
"TaxAmount": null,
"InvoiceText": null,
"CancelReason": null,
"CanceledDate": null,
"CanceledAmount": null,
"ClosedDate": null,
"CloseReason": null,
"ClosedAmount": null,
"ReturnCreditMethod": null,
"SuppressedCreditAmount": null,
"InvoicedAmount": null,
"CreditedAmount": null,
"RenewedDate": null,
"RenewalType": null,
"TaxError": null,
"CreatedBy": "CONMGR",
"CreationDate": "2019-06-04T18:08:34+00:00",
"LastUpdatedBy": "CONMGR",
"LastUpdateDate": "2019-06-04T18:08:38.099+00:00",
"LastUpdateLogin": "8A5689AE12D939D9E05322EAF40A63A4",

75 | P a g e
 Subscription Management REST Documentation

"CurrencyCode": null,
"CorpCurrencyCode": null,
"CurcyConvRateType": null,
"PutOnHoldFlag": null,
"RemoveHoldFlag": null,
...
}

Delete a Subscription Product Covered Level

Method: DELETE

URI:
/crmRestApi/resources/[Link]/subscriptions/{SubscriptionPUID}/child/products/{SubscriptionProd
uctPUID}/child/coveredLevels/{SubscriptionCoveredLevelPUID}

Media Type: application/[Link]+json, application/json

Example:

[Link]
5678/child/products/GP-5678-PRDT-7/child/coveredLevels/GP-5678-PRDT-7-PASS-1

Response Body:

Blank

Status: 204 No Content

Get a Subscription Product Covered Level

Method: GET

URI:
/crmRestApi/resources/[Link]/subscriptions/{SubscriptionPUID}/child/products/{SubscriptionProd
uctPUID}/child/coveredLevels/{SubscriptionCoveredLevelPUID}

Media Type: application/[Link]+json, application/json

Example:

[Link]
5678/child/products/GP-5678-PRDT-7/child/coveredLevels/GP-5678-PRDT-7-PASS-1

Response Body:

76 | P a g e
 Subscription Management REST Documentation

"CoveredLevelId": 300100177231548,
"CoveredLevelPuid": "GP-5678-PRDT-7-PASS-1",
"SubscriptionProductId": 300100177231547,
"SubscriptionId": 300100177254423,
"LineNumber": "1",
"InventoryItemId": 300100118490672,
"AssetId": 300100118585763,
"AssetName": "zOKC_Auto_Asset1",
"AssetSerialNumber": null,
"ProductName": "ZOKC_Item_001",
"Description": "Item",
"Type": "ORA_ASSET",
"TypeName": "Asset",
"Quantity": 1,
"ItemUnitOfMeasure": "Ea",
"TotalContractValue": 12361.29,
"GenerateBillingSchedule": null,
"EndDate": "2019-12-25",
"StartDate": "2019-01-01",
"Duration": 359,
"Period": "DY",
"Status": "ORA_DRAFT",
"StatusName": "Draft",
"PriceAsOf": "2019-01-01",
"PriceUnitOfMeasure": "0zE",
"PriceUnitOfMeasureName": "YEAR",
"PriceListId": 300100071623855,
"PricingError": null,
"TaxAmount": 2472.26,
"InvoiceText": null,
"CancelReason": null,
"CanceledDate": null,
"CanceledAmount": null,
"ClosedDate": null,
"CloseReason": null,
"ClosedAmount": null,
"ReturnCreditMethod": null,
"SuppressedCreditAmount": null,
"InvoicedAmount": null,
"CreditedAmount": null,
"RenewedDate": null,
"RenewalType": null,
"TaxError": null,
"CreatedBy": "CONMGR",
"CreationDate": "2019-06-04T17:55:14.831+00:00",
"LastUpdatedBy": "CONMGR",
"LastUpdateDate": "2019-06-04T17:56:01.036+00:00",
"LastUpdateLogin": "8A568A7FD0B9BE1EE05323EAF40A0287",
"CurrencyCode": null,
"CorpCurrencyCode": null,
"CurcyConvRateType": null,
"PutOnHoldFlag": null,
"RemoveHoldFlag": null,
...
}

77 | P a g e
 Subscription Management REST Documentation

Get Subscription Product Covered Levels

Method: GET

URI:
/crmRestApi/resources/[Link]/subscriptions/{SubscriptionPUID}/child/products/{SubscriptionProd
uctPUID}/child/coveredLevels

Media Type: application/[Link]+json, application/json

Example:

[Link]
5678/child/products/GP-5678-PRDT-7/child/coveredLevels

Response Body:

{
"items": [
{
"CoveredLevelId": 300100177231548,
"CoveredLevelPuid": "GP-5678-PRDT-7-PASS-1",
"SubscriptionProductId": 300100177231547,
"SubscriptionId": 300100177254423,
"LineNumber": "1",
"InventoryItemId": 300100118490672,
"AssetId": 300100118585763,
"AssetName": "zOKC_Auto_Asset1",
"AssetSerialNumber": null,
"ProductName": "ZOKC_Item_001",
"Description": "Item",
"Type": "ORA_ASSET",
"TypeName": "Asset",
"Quantity": 1,
"ItemUnitOfMeasure": "Ea",
"TotalContractValue": 12361.29,
"GenerateBillingSchedule": null,
"EndDate": "2019-12-25",
"StartDate": "2019-01-01",
"Duration": 359,
"Period": "DY",
"Status": "ORA_DRAFT",
"StatusName": "Draft",
"PriceAsOf": "2019-01-01",
"PriceUnitOfMeasure": "0zE",
"PriceUnitOfMeasureName": "YEAR",
"PriceListId": 300100071623855,
"PricingError": null,
"TaxAmount": 2472.26,
"InvoiceText": null,
"CancelReason": null,
"CanceledDate": null,

78 | P a g e
 Subscription Management REST Documentation

"CanceledAmount": null,
"ClosedDate": null,
"CloseReason": null,
"ClosedAmount": null,
"ReturnCreditMethod": null,
"SuppressedCreditAmount": null,
"InvoicedAmount": null,
"CreditedAmount": null,
"RenewedDate": null,
"RenewalType": null,
"TaxError": null,
"CreatedBy": "CONMGR",
"CreationDate": "2019-06-04T17:55:14.831+00:00",
"LastUpdatedBy": "CONMGR",
"LastUpdateDate": "2019-06-04T17:56:01.036+00:00",
"LastUpdateLogin": "8A568A7FD0B9BE1EE05323EAF40A0287",
"CurrencyCode": null,
"CorpCurrencyCode": null,
"CurcyConvRateType": null,
"PutOnHoldFlag": null,
"RemoveHoldFlag": null,
...
}
],
"count": 1,
"hasMore": false,
"limit": 25,
"offset": 0,
...
}

Cancel a Subscription Product Covered Level (Custom)

Method: PATCH

URI:
/crmRestApi/resources/[Link]/subscriptions/{SubscriptionPUID}/child/products/{SubscriptionProd
uctPUID}/child/coveredLevels/{CoveredLevelPUID}

Media Type: application/[Link]+json, application/json

Example:

[Link]
5678/child/products/GP-5678-PRDT-7/child/coveredLevels/GP-5678-PRDT-7-PASS-1

Request Body:

{
"CancelReason": "ORA_PRICING",
"CanceledDate": "2019-06-05"

79 | P a g e
 Subscription Management REST Documentation

Response Body:

{
"CoveredLevelId": 300100177254431,
"CoveredLevelPuid": "GP-5678-PRDT-7-PASS-1",
"SubscriptionProductId": 300100177231547,
"SubscriptionId": 300100177254423,
"LineNumber": "1",
"InventoryItemId": 300100118490672,
"AssetId": 300100118585763,
"AssetName": "zOKC_Auto_Asset1",
"AssetSerialNumber": null,
"ProductName": "ZOKC_Item_001",
"Description": "Item",
"Type": "ORA_ASSET",
"TypeName": "Asset",
"Quantity": 1,
"ItemUnitOfMeasure": "Ea",
"TotalContractValue": 12361.29,
"GenerateBillingSchedule": null,
"EndDate": "2019-12-25",
"StartDate": "2019-01-01",
"Duration": 359,
"Period": "DY",
"Status": "ORA_DRAFT",
"StatusName": "Draft",
"PriceAsOf": "2019-01-01",
"PriceUnitOfMeasure": "0zE",
"PriceUnitOfMeasureName": "YEAR",
"PriceListId": null,
"PricingError": null,
"TaxAmount": null,
"InvoiceText": null,
"CancelReason": "ORA_PRICING",
"CanceledDate": "2019-06-05",
"CanceledAmount": null,
"ClosedDate": null,
"CloseReason": null,
"ClosedAmount": null,
"ReturnCreditMethod": null,
"SuppressedCreditAmount": null,
"InvoicedAmount": null,
"CreditedAmount": null,
"RenewedDate": null,
"RenewalType": null,
"TaxError": null,
"CreatedBy": "CONMGR",
"CreationDate": "2019-06-04T18:08:34+00:00",
"LastUpdatedBy": "CONMGR",
"LastUpdateDate": "2019-06-05T07:15:15+00:00",
"LastUpdateLogin": "8A5689AE12D939D9E05322EAF40A63A4",
"CurrencyCode": null,
"CorpCurrencyCode": null,
"CurcyConvRateType": null,

80 | P a g e
 Subscription Management REST Documentation

"PutOnHoldFlag": null,
"RemoveHoldFlag": null,
...
}

Close a Subscription Product Covered Level (Custom)

Method: PATCH

URI:
crmRestApi/resources/latest/subscriptions/{SubscriptionPUID}/child/products/{SubscriptionProductPUI
D}/child/coveredLevels/{CoveredLevelPUID}

Media Type: application/[Link]+json, application/json

Example:

[Link]
4455/child/products/GP-4455-PRDT-11/child/coveredLevels/GP-4455-PRDT-11-PASS-4

Request Body:

{
"ClosedDate" : "2019-06-10",
"CloseReason" : "ORA_NON_COMPLIANCE",
"ReturnCreditMethod" : "ORA_FULL"
}

Response Body:

{
"CoveredLevelId": 300100177232445,
"CoveredLevelPuid": "GP-4455-PRDT-11-PASS-4",
"SubscriptionProductId": 300100177232440,
"SubscriptionId": 300100177232437,
"LineNumber": "1",
"InventoryItemId": 300100118490672,
"AssetId": 300100118585763,
"AssetName": "zOKC_Auto_Asset1",
"AssetSerialNumber": null,
"ProductName": "ZOKC_Item_001",
"Description": "Item",
"Type": "ORA_ASSET",
"TypeName": "Asset",
"Quantity": 1,
"ItemUnitOfMeasure": "Ea",
"TotalContractValue": 12361.29,
"GenerateBillingSchedule": null,
"EndDate": "2019-12-25",
"StartDate": "2019-01-01",

81 | P a g e
 Subscription Management REST Documentation

"Duration": 359,
"Period": "DY",
"Status": "ORA_ACTIVE",
"StatusName": "Active",
"PriceAsOf": "2019-06-05",
"PriceUnitOfMeasure": "0zE",
"PriceUnitOfMeasureName": "YEAR",
"PriceListId": 300100071623855,
"PricingError": null,
"TaxAmount": 0,
"InvoiceText": null,
"CancelReason": null,
"CanceledDate": null,
"CanceledAmount": null,
"ClosedDate": "2019-06-10",
"CloseReason": "ORA_NON_COMPLIANCE",
"ClosedAmount": null,
"ReturnCreditMethod": "ORA_FULL",
"SuppressedCreditAmount": null,
"InvoicedAmount": null,
"CreditedAmount": null,
"RenewedDate": null,
"RenewalType": null,
"TaxError": null,
"CreatedBy": "CONMGR",
"CreationDate": "2019-06-05T07:19:23.998+00:00",
"LastUpdatedBy": "CONMGR",
"LastUpdateDate": "2019-06-05T07:22:50+00:00",
"LastUpdateLogin": "8A5689AE12D939D9E05322EAF40A63A4",
"CurrencyCode": null,
"CorpCurrencyCode": null,
"CurcyConvRateType": null,
"PutOnHoldFlag": null,
"RemoveHoldFlag": null,
...
}

Subscription Product Charges

Create a Subscription Product Charge

Method: POST

URI:
crmRestApi/resources/latest/subscriptions/{SubscriptionPUID}/child/products/{SubscriptionProductPUI
D}/child/charges

Media Type: application/[Link]+json, application/json

Example:

82 | P a g e
 Subscription Management REST Documentation

[Link]
5678/child/products/GP-5678-PRDT-1/child/charges

Request Body:

{
"BillLineId": null,
"ChargeDefinition": "USAGE_CHARGESPM",
"ChargePuid": "GP-5678-PRDT-1-CHRG-11",
"PricePeriodicity": "0zG",
"PriceType": "RECURRING",
"ChargeName": "USAGE SPM CHARGE",
"UnitListPrice": 20,
"TieredFlag": true
}

Response Body:

{
"BillLineId": null,
"ChargeDefinition": "USAGE_CHARGESPM",
"ChargeId": 300100177241437,
"ChargePuid": "GP-5678-PRDT-1-CHRG-11",
"CoveredLevelId": null,
"PrePaymentNumber": null,
"PricePeriodicity": "0zG",
"PriceType": "RECURRING",
"RollupFlag": null,
"SequenceNumber": null,
"SubscriptionId": 300100177254423,
"SubscriptionProductId": 300100177254429,
"ChargeName": "USAGE SPM CHARGE",
"ExternalKey": null,
"ExternalParentKey": null,
"UnitListPrice": 20,
"Allowance": null,
"BlockSize": null,
"TieredFlag": true,
"TierType": null,
"UsagePriceLockFlag": null,
"PricePeriodicityName": "MONTH",
"ChargeDefinitionName": null,
"CreatedBy": "CONMGR",
"CreationDate": "2019-06-04T13:23:55+00:00",
"LastUpdateDate": "2019-06-04T13:23:55.473+00:00",
"LastUpdateLogin": "8A5689BEEA6839CBE05322EAF40A0656",
"LastUpdatedBy": "CONMGR",
…
}

Update a Subscription Product Charge

83 | P a g e
 Subscription Management REST Documentation

Method: PATCH

URI:
crmRestApi/resources/latest/subscriptions/{SubscriptionPUID}/child/products/{SubscriptionProductPUI
D}/child/charges/{ChargePUID}

Media Type: application/[Link]+json, application/json

Example:

[Link]
5678/child/products/GP-5678-PRDT-1/child/charges/GP-5678-PRDT-1-CHRG-11

Request Body:

{
"UnitListPrice": 30,
"TieredFlag": false
}

Response Body:

{
"BillLineId": null,
"ChargeDefinition": "USAGE_CHARGESPM",
"ChargeId": 300100177241437,
"ChargePuid": "GP-5678-PRDT-1-CHRG-11",
"CoveredLevelId": null,
"PrePaymentNumber": null,
"PricePeriodicity": "0zG",
"PriceType": "RECURRING",
"RollupFlag": null,
"SequenceNumber": null,
"SubscriptionId": 300100177254423,
"SubscriptionProductId": 300100177254429,
"ChargeName": "USAGE SPM CHARGE",
"ExternalKey": null,
"ExternalParentKey": null,
"UnitListPrice": 30,
"Allowance": null,
"BlockSize": null,
"TieredFlag": false,
"TierType": null,
"UsagePriceLockFlag": null,
"PricePeriodicityName": "MONTH",
"ChargeDefinitionName": null,
"CreatedBy": "CONMGR",
"CreationDate": "2019-06-04T13:23:55+00:00",
"LastUpdateDate": "2019-06-04T13:23:55.473+00:00",
"LastUpdateLogin": "8A5689BEEA6839CBE05322EAF40A0656",
"LastUpdatedBy": "CONMGR",
…
}

84 | P a g e
 Subscription Management REST Documentation

Delete a Subscription Product Charge

Method: DELETE

URI:
crmRestApi/resources/latest/subscriptions/{SubscriptionPUID}/child/products/{SubscriptionProductPUI
D}/child/charges/{ChargePUID}

Media Type: application/[Link]+json, application/json

Example:

[Link]
5678/child/products/GP-5678-PRDT-1/child/charges/GP-5678-PRDT-1-CHRG-11

Response Body:

Blank

Status: 204 No Content

Get a Subscription Product Charge

Method: GET

URI:
/crmRestApi/resources/[Link]/subscriptions/{SubscriptionPUID}/child/products/{SubscriptionProd
uctPUID}/child/charges/{ChargePUID}

Media Type: application/[Link]+json, application/json

Example:

[Link]
5678/child/products/GP-5678-PRDT-1/child/charges/GP-5678-PRDT-1-CHRG-11

Response Body:

{
"BillLineId": null,
"ChargeDefinition": "USAGE_CHARGESPM",
"ChargeId": 300100177241437,
"ChargePuid": "GP-5678-PRDT-1-CHRG-11",

85 | P a g e
 Subscription Management REST Documentation

"CoveredLevelId": null,
"PrePaymentNumber": null,
"PricePeriodicity": "0zG",
"PriceType": "RECURRING",
"RollupFlag": null,
"SequenceNumber": null,
"SubscriptionId": 300100177254423,
"SubscriptionProductId": 300100177254429,
"ChargeName": "USAGE SPM CHARGE",
"ExternalKey": null,
"ExternalParentKey": null,
"UnitListPrice": 20,
"Allowance": null,
"BlockSize": null,
"TieredFlag": true,
"TierType": null,
"UsagePriceLockFlag": null,
"PricePeriodicityName": "MONTH",
"ChargeDefinitionName": null,
"CreatedBy": "CONMGR",
"CreationDate": "2019-06-04T13:23:55+00:00",
"LastUpdateDate": "2019-06-04T13:23:55.473+00:00",
"LastUpdateLogin": "8A5689BEEA6839CBE05322EAF40A0656",
"LastUpdatedBy": "CONMGR",
…
}

Get Subscription Product Charges

Method: GET

URI:
/crmRestApi/resources/[Link]/subscriptions/{SubscriptionPUID}/child/products/{SubscriptionProd
uctPUID}/child/charges

Media Type: application/[Link]+json, application/json

Example:

[Link]
5678/child/products/GP-5678-PRDT-1/child/charges

Response Body:

{
"items": [
{
"BillLineId": null,
"ChargeDefinition": "ACTIVATIONFEE",
"ChargeId": 300100177231506,
"ChargePuid": "GP-5678-PRDT-1-CHRG-9",

86 | P a g e
 Subscription Management REST Documentation

"CoveredLevelId": null,
"PrePaymentNumber": null,
"PricePeriodicity": null,
"PriceType": "ONE_TIME",
"RollupFlag": false,
"SequenceNumber": 1,
"SubscriptionId": 300100177254423,
"SubscriptionProductId": 300100177254429,
"ChargeName": "Activation Fee",
"ExternalKey": null,
"ExternalParentKey": null,
"UnitListPrice": 3000,
"Allowance": null,
"BlockSize": null,
"TieredFlag": null,
"TierType": null,
"UsagePriceLockFlag": null,
"PricePeriodicityName": null,
"ChargeDefinitionName": null,
"CreatedBy": "CONMGR",
"CreationDate": "2019-06-04T13:03:07.445+00:00",
"LastUpdateDate": "2019-06-04T13:03:07.536+00:00",
"LastUpdateLogin": "8A568A7FD0B9BE1EE05323EAF40A0287",
"LastUpdatedBy": "CONMGR",
...
},
{
"BillLineId": null,
"ChargeDefinition": "MONTHLYFEE",
"ChargeId": 300100177231507,
"ChargePuid": "GP-5678-PRDT-1-CHRG-10",
"CoveredLevelId": null,
"PrePaymentNumber": null,
"PricePeriodicity": "0zG",
"PriceType": "RECURRING",
"RollupFlag": false,
"SequenceNumber": 2,
"SubscriptionId": 300100177254423,
"SubscriptionProductId": 300100177254429,
"ChargeName": "Monthly Fee",
"ExternalKey": null,
"ExternalParentKey": null,
"UnitListPrice": 300,
"Allowance": null,
"BlockSize": null,
"TieredFlag": null,
"TierType": null,
"UsagePriceLockFlag": null,
"PricePeriodicityName": "MONTH",
"ChargeDefinitionName": null,
"CreatedBy": "CONMGR",
"CreationDate": "2019-06-04T13:03:07.452+00:00",
"LastUpdateDate": "2019-06-04T13:03:07.542+00:00",
"LastUpdateLogin": "8A568A7FD0B9BE1EE05323EAF40A0287",
"LastUpdatedBy": "CONMGR",
…
},

87 | P a g e
 Subscription Management REST Documentation

{
"BillLineId": null,
"ChargeDefinition": "USAGE_CHARGESPM",
"ChargeId": 300100177231508,
"ChargePuid": "GP-5678-PRDT-1-CHRG-11",
"CoveredLevelId": null,
"PrePaymentNumber": null,
"PricePeriodicity": "0zG",
"PriceType": "RECURRING",
"RollupFlag": false,
"SequenceNumber": 3,
"SubscriptionId": 300100177254423,
"SubscriptionProductId": 300100177254429,
"ChargeName": "USAGE SPM CHARGE",
"ExternalKey": null,
"ExternalParentKey": null,
"UnitListPrice": 20,
"Allowance": null,
"BlockSize": null,
"TieredFlag": true,
"TierType": null,
"UsagePriceLockFlag": null,
"PricePeriodicityName": "MONTH",
"ChargeDefinitionName": null,
"CreatedBy": "CONMGR",
"CreationDate": "2019-06-04T13:03:07.456+00:00",
"LastUpdateDate": "2019-06-04T13:05:27.609+00:00",
"LastUpdateLogin": "8A568A7FD0B9BE1EE05323EAF40A0287",
"LastUpdatedBy": "CONMGR",
…
}

Subscription Product Charge Adjustments

Create a Product Charge Adjustment

Method: POST

URI:
/crmRestApi/resources/[Link]/subscriptions/{SubscriptionPUID}/child/products/{SubscriptionProd
uctPUID}/child/charges/{ChargePUID}/child/adjustments/

Media Type: application/[Link]+json, application/json

Example:

[Link]
5678/child/products/GP-5678-PRDT-1/child/charges/GP-5678-PRDT-1-CHRG-9/child/adjustments

Request Body:

88 | P a g e
 Subscription Management REST Documentation

{
"ChargeAdjustmentPuid": "GP-5678-PRDT-1-CHRG-9-MADJ-1",
"AdjustmentType": "ORA_DISCOUNT_AMOUNT",
"AdjustmentValue": 500,
"Reason": "Special offer",
"SequenceNumber": 1,
"AdjustmentName": "One Time Off",
"Effectivity": "ORA_ALL_TERM"
}

Response Body:

{
"ChargeAdjustmentId": 300100177242432,
"ChargeAdjustmentPuid": "GP-5678-PRDT-1-CHRG-9-MADJ-1",
"ChargeId": 300100177231506,
"PeriodFrom": null,
"PeriodUntil": null,
"AdjustmentType": "ORA_DISCOUNT_AMOUNT",
"AdjustmentValue": 500,
"AdjustmentBasis": null,
"Reason": "Special offer",
"SequenceNumber": 1,
"SubscriptionId": 300100177254423,
"SubscriptionProductId": 300100177254429,
"AdjustmentName": "One Time Off",
"AutoAdjustmentFlag": null,
"Effectivity": "ORA_ALL_TERM",
"NumberOfPeriods": null,
"ObjectVersionNumber": 1,
"CreatedBy": "CONMGR",
"CreationDate": "2019-06-04T14:06:49+00:00",
"LastUpdateDate": "2019-06-04T14:06:49.706+00:00",
"LastUpdateLogin": "8A5689BEEA6839CBE05322EAF40A0656",
"LastUpdatedBy": "CONMGR",
...
}

Update a Product Charge Adjustment

Method: POST

URI:
/crmRestApi/resources/[Link]/subscriptions/{SubscriptionPUID}/child/products/{SubscriptionProd
uctPUID}/child/charges/{ChargePUID}/child/adjustments/{ChargeAdjustmentPUID}

Media Type: application/[Link]+json, application/json

Example:

89 | P a g e
 Subscription Management REST Documentation

[Link]
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:

{
"ChargeAdjustmentId": 300100177242432,
"ChargeAdjustmentPuid": "GP-5678-PRDT-1-CHRG-9-MADJ-1",
"ChargeId": 300100177231506,
"PeriodFrom": null,
"PeriodUntil": null,
"AdjustmentType": "ORA_DISCOUNT_AMOUNT",
"AdjustmentValue": 600,
"AdjustmentBasis": null,
"Reason": "Special offer",
"SequenceNumber": 1,
"SubscriptionId": 300100177254423,
"SubscriptionProductId": 300100177254429,
"AdjustmentName": "One Time Off",
"AutoAdjustmentFlag": null,
"Effectivity": "ORA_ALL_TERM",
"NumberOfPeriods": null,
"ObjectVersionNumber": 1,
"CreatedBy": "CONMGR",
"CreationDate": "2019-06-04T14:06:49+00:00",
"LastUpdateDate": "2019-06-04T14:06:49.706+00:00",
"LastUpdateLogin": "8A5689BEEA6839CBE05322EAF40A0656",
"LastUpdatedBy": "CONMGR",
...
}

Delete a Product Charge Adjustment

Method: DELETE

URI:
/crmRestApi/resources/[Link]/subscriptions/{SubscriptionPUID}/child/products/{SubscriptionProd
uctPUID}/child/charges/{ChargePUID}/child/adjustments/{ChargeAdjustmentPUID}

Media Type: application/[Link]+json, application/json

Example:

90 | P a g e
 Subscription Management REST Documentation

[Link]
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

Response Body:

Blank

Status: 204 No Content

Get a Product Charge Adjustment

Method: GET

URI:
/crmRestApi/resources/[Link]/subscriptions/{SubscriptionPUID}/child/products/{SubscriptionProd
uctPUID}/child/charges/{ChargePUID}/child/adjustments/{ChargeAdjustmentPUID}

Media Type: application/[Link]+json, application/json

Example:

[Link]
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

Response Body:

{
"ChargeAdjustmentId": 300100177231521,
"ChargeAdjustmentPuid": "GP-5678-PRDT-1-CHRG-9-MADJ-1",
"ChargeId": 300100177231506,
"PeriodFrom": null,
"PeriodUntil": null,
"AdjustmentType": "ORA_DISCOUNT_AMOUNT",
"AdjustmentValue": 500,
"AdjustmentBasis": null,
"Reason": "Special offer",
"SequenceNumber": 1,
"SubscriptionId": 300100177254423,
"SubscriptionProductId": 300100177254429,
"AdjustmentName": "One Time Off",
"AutoAdjustmentFlag": false,
"Effectivity": "ORA_ALL_TERM",
"NumberOfPeriods": null,
"ObjectVersionNumber": 1,
"CreatedBy": "CONMGR",
"CreationDate": "2019-06-04T13:54:33.442+00:00",

91 | P a g e
 Subscription Management REST Documentation

"LastUpdateDate": "2019-06-04T13:55:16.590+00:00",
"LastUpdateLogin": "8A568A7FD0B9BE1EE05323EAF40A0287",
"LastUpdatedBy": "CONMGR",
...
}

Get Product Charge Adjustments

Method: GET

URI:
/crmRestApi/resources/[Link]/subscriptions/{SubscriptionPUID}/child/products/{SubscriptionProd
uctPUID}/child/charges/{ChargePUID}/child/adjustments

Media Type: application/[Link]+json, application/json

Example:

[Link]
5678/child/products/GP-5678-PRDT-1/child/charges/GP-5678-PRDT-1-CHRG-9/child/adjustments

Response Body:

{
"items": [
{
"ChargeAdjustmentId": 300100177231521,
"ChargeAdjustmentPuid": "GP-5678-PRDT-1-CHRG-9-MADJ-1",
"ChargeId": 300100177231506,
"PeriodFrom": null,
"PeriodUntil": null,
"AdjustmentType": "ORA_DISCOUNT_AMOUNT",
"AdjustmentValue": 500,
"AdjustmentBasis": null,
"Reason": "Special offer",
"SequenceNumber": 1,
"SubscriptionId": 300100177254423,
"SubscriptionProductId": 300100177254429,
"AdjustmentName": "One Time Off",
"AutoAdjustmentFlag": false,
"Effectivity": "ORA_ALL_TERM",
"NumberOfPeriods": null,
"ObjectVersionNumber": 1,
"CreatedBy": "CONMGR",
"CreationDate": "2019-06-04T13:54:33.442+00:00",
"LastUpdateDate": "2019-06-04T13:55:16.590+00:00",
"LastUpdateLogin": "8A568A7FD0B9BE1EE05323EAF40A0287",
"LastUpdatedBy": "CONMGR",
...
"count": 1,
"hasMore": false,
"limit": 25,

92 | P a g e
 Subscription Management REST Documentation

"offset": 0,
...
}

Subscription Product Bill Lines

Create a Subscription Product Bill Line

Method: POST

URI:
/crmRestApi/resources/[Link]/subscriptions/{SubscriptionPUID}/child/products/{SubscriptionProd
uctPUID}/child/billLines

Media Type: application/[Link]+json, application/json

Example:

[Link]
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,
"BillLinePuid": "GP-5678-PRDT-1-BILL-309",
"SubscriptionId": 300100177254423,
"SubscriptionProductId": 300100177254429,

93 | P a g e
 Subscription Management REST Documentation

"CoveredLevelId": null,
"ChargeId": 300100177231506,
"ChargePuid": null,
"BillingPeriod": 0,
"DateToInterface": "2019-06-04",
"DateBilledFrom": "2019-01-01",
"DateBilledTo": "2019-12-25",
"Amount": 2600,
"RecurringFlag": false,
"UsageFlag": false,
"UsageAcquiredFlag": null,
"UsagePricedFlag": true,
"InterfacedFlag": false,
"TransactionClass": "INV",
"TransactionDate": null,
"TransactionNumber": null,
"TransactionTax": null,
"TransactionAmount": null,
"InvoiceText": "[$Item Name]: Activation Fee 2019-01-01-2019-12-25",
"InvoiceBillLineId": null,
"UsageCaptureDate": null,
"UsageQuantity": null,
"ChargePeriod": 0,
"PricingError": null,
"ListPrice": 3000,
"RevenueLineId": null,
"CreatedBy": "CONMGR",
"CreationDate": "2019-06-04T16:52:11+00:00",
"LastUpdatedBy": "CONMGR",
"LastUpdateDate": "2019-06-04T16:52:11.109+00:00",
"LastUpdateLogin": "8A5689BEEA6839CBE05322EAF40A0656",
"TransactionClassMeaning": "Invoice",
"InvoiceDate": null,
"NewCreditMemoPUID": null,
"CreditMemoAmount": null,
"CreditMemoFlag": null,
"CreditMemoReason": null,
...
}

Update a Subscription Product Bill Line

Method: PATCH

URI:
/crmRestApi/resources/[Link]/subscriptions/{SubscriptionPUID}/child/products/{SubscriptionProd
uctPUID}/child/billLines/{BillLinePUID}

Media Type: application/[Link]+json, application/json

Example:

94 | P a g e
 Subscription Management REST Documentation

[Link]
5678/child/products/GP-5678-PRDT-1/child/billLines/GP-5678-PRDT-1-BILL-309

Request Body:

{
"Amount": 2600
}

Response Body:

{
"BillLineId": 100100108482104,
"BillLinePuid": "GP-5678-PRDT-1-BILL-309",
"SubscriptionId": 300100177254423,
"SubscriptionProductId": 300100177254429,
"CoveredLevelId": null,
"ChargeId": 300100177231506,
"ChargePuid": null,
"BillingPeriod": 0,
"DateToInterface": "2019-06-04",
"DateBilledFrom": "2019-01-01",
"DateBilledTo": "2019-12-25",
"Amount": 2600,
"RecurringFlag": false,
"UsageFlag": false,
"UsageAcquiredFlag": null,
"UsagePricedFlag": true,
"InterfacedFlag": false,
"TransactionClass": "INV",
"TransactionDate": null,
"TransactionNumber": null,
"TransactionTax": null,
"TransactionAmount": null,
"InvoiceText": "[$Item Name]: Activation Fee 2019-01-01-2019-12-25",
"InvoiceBillLineId": null,
"UsageCaptureDate": null,
"UsageQuantity": null,
"ChargePeriod": 0,
"PricingError": null,
"ListPrice": 3000,
"RevenueLineId": null,
"CreatedBy": "CONMGR",
"CreationDate": "2019-06-04T13:55:16+00:00",
"LastUpdatedBy": "CONMGR",
"LastUpdateDate": "2019-06-04T16:47:10.018+00:00",
"LastUpdateLogin": "8A5689BEEA6839CBE05322EAF40A0656",
"TransactionClassMeaning": "Invoice",
"InvoiceDate": "2019-06-04",
"NewCreditMemoPUID": null,
"CreditMemoAmount": null,
"CreditMemoFlag": null,
"CreditMemoReason": null,
...
}

95 | P a g e
 Subscription Management REST Documentation

Update a Subscription Product Bill Line for Usage Quantity

Method: PATCH

URI:
/crmRestApi/resources/[Link]/subscriptions/{SubscriptionPUID}/child/products/{SubscriptionProd
uctPUID}/child/billLines/{BillLinePUID}

Media Type: application/[Link]+json, application/json

Example:

[Link]
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",
"SubscriptionId": 300100184551026,
"SubscriptionProductId": 300100184551032,
"CoveredLevelId": null,
"ChargeId": 300100184551035,
"ChargePuid": null,
"BillingPeriod": 1,
"DateToInterface": "2020-02-01",
"DateBilledFrom": "2020-01-30",
"DateBilledTo": "2020-01-31",
"Amount": 0,
"RecurringFlag": true,
"UsageFlag": true,
"UsageAcquiredFlag": null,
"UsagePricedFlag": false,
"InterfacedFlag": false,
"TransactionClass": "INV",
"TransactionDate": null,
"TransactionNumber": null,
"TransactionTax": null,
"TransactionAmount": null,
"InvoiceText": "[$Item Name]: Data_Storage_Fee 2020-01-30-2020-01-31",
"InvoiceBillLineId": null,
"ChargeDefinition": "USAGE_OSS_DF",

96 | P a g e
 Subscription Management REST Documentation

"UsageCaptureDate": null,
"UsageQuantity": 150,
"ChargePeriod": 1,
"PricingError": null,
"ListPrice": 0,
"RevenueLineId": null,
"CreatedBy": "CONMGR",
"CreationDate": "2020-01-30T15:55:19+00:00",
"LastUpdatedBy": "CONMGR",
"LastUpdateDate": "2020-01-30T16:52:13+00:00",
"LastUpdateLogin": "9CD631AD91BF8018E05322EAF40AD740",
"TransactionClassMeaning": "Invoice",
"ChargeName": "Data_Storage_Fee",
"TrxId": null,
"TrxLineId": null,
"InvoiceDate": "2020-02-01",
"NewCreditMemoPUID": null,
"CreditMemoAmount": null,
"CreditMemoFlag": null,
"CreditMemoReason": null,
"CustomerTrxTypeSequenceId": 806,
"links": [
...
]
}

Delete a Subscription Product Bill Line

Method: DELETE

URI:
/crmRestApi/resources/[Link]/subscriptions/{SubscriptionPUID}/child/products/{SubscriptionProd
uctPUID}/child/billLines/{BillLinePUID}

Media Type: application/[Link]+json, application/json

Example:

[Link]
5678/child/products/GP-5678-PRDT-1/child/billLines/GP-5678-PRDT-1-BILL-309

Response Body:

Blank

Status: 204 No Content

97 | P a g e
 Subscription Management REST Documentation

Get a Subscription Product Bill Line

Method: GET

URI:
/crmRestApi/resources/[Link]/subscriptions/{SubscriptionPUID}/child/products/{SubscriptionProd
uctPUID}/child/billLines/{BillLinePUID}

Media Type: application/[Link]+json, application/json

Example:

[Link]
5678/child/products/GP-5678-PRDT-1/child/billLines/GP-5678-PRDT-1-BILL-309

Response Body:

{
"BillLineId": 100100108482104,
"BillLinePuid": "GP-5678-PRDT-1-BILL-309",
"SubscriptionId": 300100177254423,
"SubscriptionProductId": 300100177254429,
"CoveredLevelId": null,
"ChargeId": 300100177231506,
"ChargePuid": null,
"BillingPeriod": 0,
"DateToInterface": "2019-06-04",
"DateBilledFrom": "2019-01-01",
"DateBilledTo": "2019-12-25",
"Amount": 2500,
"RecurringFlag": false,
"UsageFlag": false,
"UsageAcquiredFlag": null,
"UsagePricedFlag": true,
"InterfacedFlag": false,
"TransactionClass": "INV",
"TransactionDate": null,
"TransactionNumber": null,
"TransactionTax": null,
"TransactionAmount": null,
"InvoiceText": "[$Item Name]: Activation Fee 2019-01-01-2019-12-25",
"InvoiceBillLineId": null,
"UsageCaptureDate": null,
"UsageQuantity": null,
"ChargePeriod": 0,
"PricingError": null,
"ListPrice": 3000,
"RevenueLineId": null,
"CreatedBy": "CONMGR",
"CreationDate": "2019-06-04T13:55:16+00:00",
"LastUpdatedBy": "CONMGR",
"LastUpdateDate": "2019-06-04T13:55:16+00:00",

98 | P a g e
 Subscription Management REST Documentation

"LastUpdateLogin": "8A568A7FD0B9BE1EE05323EAF40A0287",
"TransactionClassMeaning": "Invoice",
"InvoiceDate": "2019-06-04",
"NewCreditMemoPUID": null,
"CreditMemoAmount": null,
"CreditMemoFlag": null,
"CreditMemoReason": null,
…
}

Get Subscription Product Bill Lines

Method: GET

URI:
/crmRestApi/resources/[Link]/subscriptions/{SubscriptionPUID}/child/products/{SubscriptionProd
uctPUID}/child/billLines

Media Type: application/[Link]+json, application/json

Example:

[Link]
5678/child/products/GP-5678-PRDT-1/child/billLines

Response Body:

{
"items": [
{
"BillLineId": 100100108482104,
"BillLinePuid": "GP-5678-PRDT-1-BILL-309",
"SubscriptionId": 300100177254423,
"SubscriptionProductId": 300100177254429,
"CoveredLevelId": null,
"ChargeId": 300100177231506,
"ChargePuid": null,
"BillingPeriod": 0,
"DateToInterface": "2019-06-04",
"DateBilledFrom": "2019-01-01",
"DateBilledTo": "2019-12-25",
"Amount": 2500,
"RecurringFlag": false,
"UsageFlag": false,
"UsageAcquiredFlag": null,
"UsagePricedFlag": true,
"InterfacedFlag": false,
"TransactionClass": "INV",
"TransactionDate": null,
"TransactionNumber": null,
"TransactionTax": null,

99 | P a g e
 Subscription Management REST Documentation

"TransactionAmount": null,
"InvoiceText": "[$Item Name]: Activation Fee 2019-01-01-2019-12-
25",
"InvoiceBillLineId": null,
"UsageCaptureDate": null,
"UsageQuantity": null,
"ChargePeriod": 0,
"PricingError": null,
"ListPrice": 3000,
"RevenueLineId": null,
"CreatedBy": "CONMGR",
"CreationDate": "2019-06-04T13:55:16+00:00",
"LastUpdatedBy": "CONMGR",
"LastUpdateDate": "2019-06-04T13:55:16+00:00",
"LastUpdateLogin": "8A568A7FD0B9BE1EE05323EAF40A0287",
"TransactionClassMeaning": "Invoice",
"InvoiceDate": "2019-06-04",
"NewCreditMemoPUID": null,
"CreditMemoAmount": null,
"CreditMemoFlag": null,
"CreditMemoReason": null,
…
},
…
]
}

Subscription Product Bill Line Adjustments

Create a Subscription Product Bill Line Adjustment

Method: POST

URI:
/crmRestApi/resources/[Link]/subscriptions/{SubscriptionPUID}/child/products/{SubscriptionProd
uctPUID}/child/billLines/{BillLinePUID}/child/billAdjustments

Media Type: application/[Link]+json, application/json

Example:

[Link]
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",
"AdjustmentValue": 100,

100 | P a g e
 Subscription Management REST Documentation

"AdjustmentType": "ORA_DISCOUNT_AMOUNT",
"AdjustmentBasis": "ORA_LIST_PRICE",
"Reason": "Customer is unhappy with the initial setup delays.",
"SequenceNumber": 1,
"AutoAdjustmentFlag": false
}

Response Body:

{
"BillAdjustmentId": 300100177242435,
"SubscriptionId": 300100177231524,
"SubscriptionProductId": 300100177231527,
"BillLineId": 100100108482578,
"BillAdjustmentPuid": "GP-7890-PRDT-6-BADJ-3",
"ChargeAdjustmentId": null,
"AdjustmentName": "$100 off",
"AdjustmentValue": 100,
"AdjustmentType": "ORA_DISCOUNT_AMOUNT",
"AdjustmentBasis": "ORA_LIST_PRICE",
"Reason": "Customer is unhappy with the initial setup delays.",
"Effectivity": null,
"NumberOfPeriods": null,
"PeriodFrom": null,
"PeriodUntil": null,
"SequenceNumber": 1,
"AutoAdjustmentFlag": false,
"CreatedBy": "CONMGR",
"CreationDate": "2019-06-04T17:34:33+00:00",
"LastUpdatedBy": "CONMGR",
"LastUpdateDate": "2019-06-04T17:34:33.527+00:00",
"LastUpdateLogin": "8A5689AE12D939D9E05322EAF40A63A4",
"CurrencyCode": null,
"BasisEnableFlag": "false",
...
}

Update a Subscription Product Bill Line Adjustment

Method: POST

URI:
/crmRestApi/resources/[Link]/subscriptions/{SubscriptionPUID}/child/products/{SubscriptionProd
uctPUID}/child/billLines/{BillLinePUID}/child/billAdjustments/{BillAdjustmentPUID}

Media Type: application/[Link]+json, application/json

Example:

101 | P a g e
 Subscription Management REST Documentation

[Link]
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:

{
"AdjustmentName": "$200 off",
"AdjustmentValue": 200,
}

Response Body:

{
"BillAdjustmentId": 300100177242435,
"SubscriptionId": 300100177231524,
"SubscriptionProductId": 300100177231527,
"BillLineId": 100100108482578,
"BillAdjustmentPuid": "GP-7890-PRDT-6-BADJ-3",
"ChargeAdjustmentId": null,
"AdjustmentName": "$200 off",
"AdjustmentValue": 200,
"AdjustmentType": "ORA_DISCOUNT_AMOUNT",
"AdjustmentBasis": "ORA_LIST_PRICE",
"Reason": "Customer is unhappy with the initial setup delays.",
"Effectivity": null,
"NumberOfPeriods": null,
"PeriodFrom": null,
"PeriodUntil": null,
"SequenceNumber": 1,
"AutoAdjustmentFlag": false,
"CreatedBy": "CONMGR",
"CreationDate": "2019-06-04T17:34:33+00:00",
"LastUpdatedBy": "CONMGR",
"LastUpdateDate": "2019-06-04T17:34:33.527+00:00",
"LastUpdateLogin": "8A5689AE12D939D9E05322EAF40A63A4",
"CurrencyCode": null,
"BasisEnableFlag": "false",
...
}

Delete a Subscription Product Bill Line Adjustment

Method: DELETE

URI:
/crmRestApi/resources/[Link]/subscriptions/{SubscriptionPUID}/child/products/{SubscriptionProd
uctPUID}/child/billLines/{BillLinePUID}/child/billAdjustments/{BillAdjustmentPUID}

Media Type: application/[Link]+json, application/json

102 | P a g e
 Subscription Management REST Documentation

Example:

[Link]
7890/child/products/GP-7890-PRDT-6/child/billLines/GP-7890-PRDT-6-BILL-
370/child/billAdjustments/GP-7890-PRDT-6-BADJ-3

Response Body:

Blank

Status: 204 Not Content

Get a Subscription Product Bill Line Adjustments

Method: GET

URI:
/crmRestApi/resources/[Link]/subscriptions/{SubscriptionPUID}/child/products/{SubscriptionProd
uctPUID}/child/billLines/{BillLinePUID}/child/billAdjustments/{BillAdjustmentPUID}

Media Type: application/[Link]+json, application/json

Example:

[Link]
7890/child/products/GP-7890-PRDT-6/child/billLines/GP-7890-PRDT-6-BILL-
370/child/billAdjustments/GP-7890-PRDT-6-BADJ-3

Response Body:

{
"BillAdjustmentId": 300100177231546,
"SubscriptionId": 300100177231524,
"SubscriptionProductId": 300100177231527,
"BillLineId": 100100108482578,
"BillAdjustmentPuid": "GP-7890-PRDT-6-BADJ-3",
"ChargeAdjustmentId": null,
"AdjustmentName": "$100 off",
"AdjustmentValue": 100,
"AdjustmentType": "ORA_DISCOUNT_AMOUNT",
"AdjustmentBasis": "ORA_LIST_PRICE",
"Reason": "Customer is unhappy with the initial setup delays.",
"Effectivity": null,
"NumberOfPeriods": null,
"PeriodFrom": null,
"PeriodUntil": null,
"SequenceNumber": 1,
"AutoAdjustmentFlag": false,
"CreatedBy": "CONMGR",
"CreationDate": "2019-06-04T17:16:03.826+00:00",

103 | P a g e
 Subscription Management REST Documentation

"LastUpdatedBy": "CONMGR",
"LastUpdateDate": "2019-06-04T17:16:45.412+00:00",
"LastUpdateLogin": "8A568A7FD0B9BE1EE05323EAF40A0287",
"CurrencyCode": null,
"BasisEnableFlag": "false",
...
}

Get Subscription Product Bill Line Adjustments

Method: GET

URI:
/crmRestApi/resources/[Link]/subscriptions/{SubscriptionPUID}/child/products/{SubscriptionProd
uctPUID}/child/billLines/{BillLinePUID}/child/billAdjustments

Media Type: application/[Link]+json, application/json

Example:

[Link]
7890/child/products/GP-7890-PRDT-6/child/billLines/GP-7890-PRDT-6-BILL-370/child/billAdjustments

Response Body:

{
"items": [
{
"BillAdjustmentId": 300100177231546,
"SubscriptionId": 300100177231524,
"SubscriptionProductId": 300100177231527,
"BillLineId": 100100108482578,
"BillAdjustmentPuid": "GP-7890-PRDT-6-BADJ-3",
"ChargeAdjustmentId": null,
"AdjustmentName": "$100 off",
"AdjustmentValue": 100,
"AdjustmentType": "ORA_DISCOUNT_AMOUNT",
"AdjustmentBasis": "ORA_LIST_PRICE",
"Reason": "Customer is unhappy with the initial setup delays.",
"Effectivity": null,
"NumberOfPeriods": null,
"PeriodFrom": null,
"PeriodUntil": null,
"SequenceNumber": 1,
"AutoAdjustmentFlag": false,
"CreatedBy": "CONMGR",
"CreationDate": "2019-06-04T17:16:03.826+00:00",
"LastUpdatedBy": "CONMGR",
"LastUpdateDate": "2019-06-04T17:16:45.412+00:00",
"LastUpdateLogin": "8A568A7FD0B9BE1EE05323EAF40A0287",
"CurrencyCode": null,

104 | P a g e
 Subscription Management REST Documentation

"BasisEnableFlag": "false",
...
}
],
"count": 1,
"hasMore": false,
"limit": 25,
"offset": 0,
...
}

Subscription Product Sales Credits

Create a Subscription Product Sales Credit

Method: POST

URI:
/crmRestApi/resources/[Link]/subscriptions/{SubscriptionPUID}/child/products/{SubscriptionProd
uctPUID}/child/salesCredits

Media Type: application/[Link]+json, application/json

Example:

[Link]
5678/child/products/GP-5678-PRDT-1/child/salesCredits

Request Body:

{
"SalesCreditPuid": "GP-5678-PRDT-1-SLCR-3",
"SalesCreditTypeId": 1,
"SalesrepId": 100000008147775,
"Percentage": 100
}

Response Body:

{
"CreatedBy": "CONMGR",
"CreationDate": "2019-06-05T04:02:15+00:00",
"EndDate": null,
"LastUpdateDate": "2019-06-05T04:02:15.098+00:00",
"LastUpdateLogin": "8A5689AE12D939D9E05322EAF40A63A4",
"LastUpdatedBy": "CONMGR",
"Percentage": 100,
"SalesCreditId": 300100177241558,
"SalesCreditPuid": "GP-5678-PRDT-1-SLCR-3",
"SalesCreditTypeId": 1,

105 | P a g e
 Subscription Management REST Documentation

"SalesrepId": 100000008147775,
"StartDate": null,
"SubscriptionId": 300100177254423,
"SubscriptionProductId": 300100177254429,
"SalesPerson": "Abhijit Chan",
"SalesCreditType": "Quota Sales Credit",
"QuotaFlag": true,
...
}

Update a Subscription Product Sales Credit

Method: POST

URI:
/crmRestApi/resources/[Link]/subscriptions/{SubscriptionPUID}/child/products/{SubscriptionProd
uctPUID}/child/salesCredits/{SalesCreditPUID}

Media Type: application/[Link]+json, application/json

Example:

[Link]
5678/child/products/GP-5678-PRDT-1/child/salesCredits/GP-5678-PRDT-1-SLCR-4

Request Body:

{
"Percentage": 70
}

Response Body:

{
"CreatedBy": "CONMGR",
"CreationDate": "2019-06-05T04:04:47.562+00:00",
"EndDate": null,
"LastUpdateDate": "2019-06-05T04:05:55.006+00:00",
"LastUpdateLogin": "8A5689AE12D939D9E05322EAF40A63A4",
"LastUpdatedBy": "CONMGR",
"Percentage": 70,
"SalesCreditId": 300100177232430,
"SalesCreditPuid": "GP-5678-PRDT-1-SLCR-4",
"SalesCreditTypeId": 2,
"SalesrepId": 100000000177813,
"StartDate": null,
"SubscriptionId": 300100177254423,
"SubscriptionProductId": 300100177254429,
"SalesPerson": "Aaron Wang",
"SalesCreditType": "Non-quota Sales Credit",

106 | P a g e
 Subscription Management REST Documentation

"QuotaFlag": false,
...
}

Delete a Subscription Product Sales Credit

Method: DELETE

URI:
/crmRestApi/resources/[Link]/subscriptions/{SubscriptionPUID}/child/products/{SubscriptionProd
uctPUID}/child/salesCredits/{SalesCreditPUID}

Media Type: application/[Link]+json, application/json

Example:

[Link]
5678/child/products/GP-5678-PRDT-1/child/salesCredits/GP-5678-PRDT-1-SLCR-3

Response Body:

Blank

Status: 204 No Content

Get a Subscription Product Sales Credit

Method: GET

URI:
/crmRestApi/resources/[Link]/subscriptions/{SubscriptionPUID}/child/products/{SubscriptionProd
uctPUID}/child/salesCredits/{SalesCreditPUID}

Media Type: application/[Link]+json, application/json

Example:

[Link]
5678/child/products/GP-5678-PRDT-1/child/salesCredits/GP-5678-PRDT-1-SLCR-3

Response Body:

{
"CreatedBy": "CONMGR",

107 | P a g e
 Subscription Management REST Documentation

"CreationDate": "2019-06-05T03:48:02.509+00:00",
"EndDate": null,
"LastUpdateDate": "2019-06-05T03:48:20.802+00:00",
"LastUpdateLogin": "8A568ABC72F139D7E05322EAF40A0F90",
"LastUpdatedBy": "CONMGR",
"Percentage": 100,
"SalesCreditId": 300100177232429,
"SalesCreditPuid": "GP-5678-PRDT-1-SLCR-3",
"SalesCreditTypeId": 1,
"SalesrepId": 100000008147775,
"StartDate": null,
"SubscriptionId": 300100177254423,
"SubscriptionProductId": 300100177254429,
"SalesPerson": "Abhijit Chan",
"SalesCreditType": "Quota Sales Credit",
"QuotaFlag": true,
...
}

Get Subscription Product Sales Credits

Method: GET

URI:
/crmRestApi/resources/[Link]/subscriptions/{SubscriptionPUID}/child/products/{SubscriptionProd
uctPUID}/child/salesCredits

Media Type: application/[Link]+json, application/json

Example:

[Link]
5678/child/products/GP-5678-PRDT-1/child/salesCredits

Response Body:

{
"items": [
{
"CreatedBy": "CONMGR",
"CreationDate": "2019-06-05T03:48:02.509+00:00",
"EndDate": null,
"LastUpdateDate": "2019-06-05T03:48:20.802+00:00",
"LastUpdateLogin": "8A568ABC72F139D7E05322EAF40A0F90",
"LastUpdatedBy": "CONMGR",
"Percentage": 100,
"SalesCreditId": 300100177232429,
"SalesCreditPuid": "GP-5678-PRDT-1-SLCR-3",
"SalesCreditTypeId": 1,
"SalesrepId": 100000008147775,
"StartDate": null,

108 | P a g e
 Subscription Management REST Documentation

"SubscriptionId": 300100177254423,
"SubscriptionProductId": 300100177254429,
"SalesPerson": "Abhijit Chan",
"SalesCreditType": "Quota Sales Credit",
"QuotaFlag": true,
...
}
],
"count": 1,
"hasMore": false,
"limit": 25,
"offset": 0,
...
}

Subscription Covered Level Charges

Create a Subscription Covered Level Charge

Method: POST

URI:
/crmRestApi/resources/[Link]/subscriptions/{SubscriptionPUID}/child/products/{SubscriptionProd
uctPUID}/child/coveredLevels/{CoveredLevelPUID}/child/charges

Media Type: application/[Link]+json, application/json

Example:

[Link]
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:

{
"ChargeDefinition": "QP_SALE_PRICE",
"ChargePuid": "GP-7788-PRDT-13-CHRG-29",
"PriceType": "ONE_TIME",
"RollupFlag": false,
"SequenceNumber": 1,
"ChargeName": "Sale Price",
"UnitListPrice": 10000
}

Response Body:

109 | P a g e
 Subscription Management REST Documentation

"BillLineId": null,
"ChargeDefinition": "QP_SALE_PRICE",
"ChargeId": 300100177242683,
"ChargePuid": "GP-7788-PRDT-13-CHRG-29",
"CoveredLevelId": 300100177232486,
"PrePaymentNumber": null,
"PricePeriodicity": null,
"PriceType": "ONE_TIME",
"RollupFlag": false,
"SequenceNumber": 1,
"SubscriptionId": 300100177232478,
"SubscriptionProductId": 300100177232481,
"ChargeName": "Sale Price",
"ExternalKey": null,
"ExternalParentKey": null,
"UnitListPrice": 10000,
"Allowance": null,
"BlockSize": null,
"TieredFlag": null,
"TierType": null,
"UsagePriceLockFlag": null,
"PricePeriodicityName": null,
"ChargeDefinitionName": null,
"CreatedBy": "CONMGR",
"CreationDate": "2019-06-05T07:43:45+00:00",
"LastUpdateDate": "2019-06-05T07:43:45.037+00:00",
"LastUpdateLogin": "8A5689AE12D939D9E05322EAF40A63A4",
"LastUpdatedBy": "CONMGR",
...
}

Update a Subscription Covered Level Charge

Method: PATCH

URI:
/crmRestApi/resources/[Link]/subscriptions/{SubscriptionPUID}/child/products/{SubscriptionProd
uctPUID}/child/coveredLevels/{CoveredLevelPUID}/child/charges/{ChargePUID}

Media Type: application/[Link]+json, application/json

Example:

[Link]
7788/child/products/GP-7788-PRDT-13/child/coveredLevels/GP-7788-PRDT-13-PASS-
5/child/charges/GP-7788-PRDT-13-CHRG-29

Request Body:

{
"UnitListPrice": 9000
}

110 | P a g e
 Subscription Management REST Documentation

Response Body:

{
"BillLineId": null,
"ChargeDefinition": "QP_SALE_PRICE",
"ChargeId": 300100177242683,
"ChargePuid": "GP-7788-PRDT-13-CHRG-29",
"CoveredLevelId": 300100177232486,
"PrePaymentNumber": null,
"PricePeriodicity": null,
"PriceType": "ONE_TIME",
"RollupFlag": false,
"SequenceNumber": 1,
"SubscriptionId": 300100177232478,
"SubscriptionProductId": 300100177232481,
"ChargeName": "Sale Price",
"ExternalKey": null,
"ExternalParentKey": null,
"UnitListPrice": 9000,
"Allowance": null,
"BlockSize": null,
"TieredFlag": null,
"TierType": null,
"UsagePriceLockFlag": null,
"PricePeriodicityName": null,
"ChargeDefinitionName": null,
"CreatedBy": "CONMGR",
"CreationDate": "2019-06-05T07:43:45+00:00",
"LastUpdateDate": "2019-06-05T07:46:54+00:00",
"LastUpdateLogin": "8A5689AE12D939D9E05322EAF40A63A4",
"LastUpdatedBy": "CONMGR",
...
}

Delete a Subscription Covered Level Charge

Method: DELETE

URI:
/crmRestApi/resources/[Link]/subscriptions/{SubscriptionPUID}/child/products/{SubscriptionProd
uctPUID}/child/coveredLevels/{CoveredLevelPUID}/child/charges/{ChargePUID}

Media Type: application/[Link]+json, application/json

Example:

[Link]
7788/child/products/GP-7788-PRDT-13/child/coveredLevels/GP-7788-PRDT-13-PASS-
5/child/charges/GP-7788-PRDT-13-CHRG-29

111 | P a g e
 Subscription Management REST Documentation

Response Body:

Blank

Status: 204 No Content

Get a Subscription Covered Level Charge

Method: GET

URI:
/crmRestApi/resources/[Link]/subscriptions/{SubscriptionPUID}/child/products/{SubscriptionProd
uctPUID}/child/coveredLevels/{CoveredLevelPUID}/child/charges/{ChargePUID}

Media Type: application/[Link]+json, application/json

Example:

[Link]
7788/child/products/GP-7788-PRDT-13/child/coveredLevels/GP-7788-PRDT-13-PASS-
5/child/charges/GP-7788-PRDT-13-CHRG-29

Response Body:

{
"BillLineId": null,
"ChargeDefinition": "QP_SALE_PRICE",
"ChargeId": 300100177232490,
"ChargePuid": "GP-7788-PRDT-13-CHRG-29",
"CoveredLevelId": 300100177232486,
"PrePaymentNumber": null,
"PricePeriodicity": null,
"PriceType": "ONE_TIME",
"RollupFlag": false,
"SequenceNumber": 1,
"SubscriptionId": 300100177232478,
"SubscriptionProductId": 300100177232481,
"ChargeName": "Sale Price",
"ExternalKey": null,
"ExternalParentKey": null,
"UnitListPrice": 10000,
"Allowance": null,
"BlockSize": null,
"TieredFlag": null,
"TierType": null,
"UsagePriceLockFlag": null,
"PricePeriodicityName": null,
"ChargeDefinitionName": null,
"CreatedBy": "CONMGR",

112 | P a g e
 Subscription Management REST Documentation

"CreationDate": "2019-06-05T07:28:29+00:00",
"LastUpdateDate": "2019-06-05T07:28:29.152+00:00",
"LastUpdateLogin": "8A568ABC72F139D7E05322EAF40A0F90",
"LastUpdatedBy": "CONMGR",
...
}

Get Subscription Covered Level Charges

Method: GET

URI:
/crmRestApi/resources/[Link]/subscriptions/{SubscriptionPUID}/child/products/{SubscriptionProd
uctPUID}/child/coveredLevels/{CoveredLevelPUID}/child/charges

Media Type: application/[Link]+json, application/json

Example:

[Link]
7788/child/products/GP-7788-PRDT-13/child/coveredLevels/GP-7788-PRDT-13-PASS-5/child/charges

Response Body:

{
"items": [
{
"BillLineId": null,
"ChargeDefinition": "QP_SALE_PRICE",
"ChargeId": 300100177232490,
"ChargePuid": "GP-7788-PRDT-13-CHRG-29",
"CoveredLevelId": 300100177232486,
"PrePaymentNumber": null,
"PricePeriodicity": null,
"PriceType": "ONE_TIME",
"RollupFlag": false,
"SequenceNumber": 1,
"SubscriptionId": 300100177232478,
"SubscriptionProductId": 300100177232481,
"ChargeName": "Sale Price",
"ExternalKey": null,
"ExternalParentKey": null,
"UnitListPrice": 10000,
"Allowance": null,
"BlockSize": null,
"TieredFlag": null,
"TierType": null,
"UsagePriceLockFlag": null,
"PricePeriodicityName": null,
"ChargeDefinitionName": null,
"CreatedBy": "CONMGR",
"CreationDate": "2019-06-05T07:28:29+00:00",

113 | P a g e
 Subscription Management REST Documentation

"LastUpdateDate": "2019-06-05T07:28:29.152+00:00",
"LastUpdateLogin": "8A568ABC72F139D7E05322EAF40A0F90",
"LastUpdatedBy": "CONMGR",
...
},
{
"BillLineId": null,
"ChargeDefinition": "ZOKC_SK_RECURRINGCHARGE",
"ChargeId": 300100177232491,
"ChargePuid": "GP-7788-PRDT-13-CHRG-30",
"CoveredLevelId": 300100177232486,
"PrePaymentNumber": null,
"PricePeriodicity": "0zG",
"PriceType": "RECURRING",
"RollupFlag": false,
"SequenceNumber": 2,
"SubscriptionId": 300100177232478,
"SubscriptionProductId": 300100177232481,
"ChargeName": "ZOKC_SK_RECURRINGCHARGE",
"ExternalKey": null,
"ExternalParentKey": null,
"UnitListPrice": 200,
"Allowance": null,
"BlockSize": null,
"TieredFlag": null,
"TierType": null,
"UsagePriceLockFlag": null,
"PricePeriodicityName": "MONTH",
"ChargeDefinitionName": null,
"CreatedBy": "CONMGR",
"CreationDate": "2019-06-05T07:28:29.007+00:00",
"LastUpdateDate": "2019-06-05T07:28:29.155+00:00",
"LastUpdateLogin": "8A568ABC72F139D7E05322EAF40A0F90",
"LastUpdatedBy": "CONMGR",
...
}
],
"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
 Subscription Management REST Documentation

URI:
/crmRestApi/resources/[Link]/subscriptions/{SubscriptionPUID}/child/products/{SubscriptionProd
uctPUID}/child/coveredLevels/{CoveredLevelPUID}/child/charges/{ChargePUID}/child/adjustments

Media Type: application/[Link]+json, application/json

Example:

[Link]
5678/child/products/GP-5678-PRDT-1/child/charges/GP-5678-PRDT-1-CHRG-9/child/adjustments

Request Body:

{
"ChargeAdjustmentPuid": "GP-7788-PRDT-13-CHRG-29-MADJ-3",
"AdjustmentType": "ORA_DISCOUNT_PERCENT",
"AdjustmentValue": 500,
"AdjustmentBasis": "ORA_LIST_PRICE",
"Reason": "Special seasonal offer",
"SequenceNumber": 1,
"AdjustmentName": "One-time Discount",
"Effectivity": "ORA_ALL_TERM"
}
Response Body:

{
"ChargeAdjustmentId": 300100177241559,
"ChargeAdjustmentPuid": "GP-7788-PRDT-13-CHRG-29-MADJ-3",
"ChargeId": 300100177242683,
"PeriodFrom": null,
"PeriodUntil": null,
"AdjustmentType": "ORA_DISCOUNT_PERCENT",
"AdjustmentValue": 500,
"AdjustmentBasis": "ORA_LIST_PRICE",
"Reason": "Special seasonal offer",
"SequenceNumber": 1,
"SubscriptionId": 300100177232478,
"SubscriptionProductId": 300100177232481,
"AdjustmentName": "One-time Discount",
"AutoAdjustmentFlag": null,
"Effectivity": "ORA_ALL_TERM",
"NumberOfPeriods": null,
"ObjectVersionNumber": 1,
"CreatedBy": "CONMGR",
"CreationDate": "2019-06-05T08:12:00+00:00",
"LastUpdateDate": "2019-06-05T08:12:00.428+00:00",
"LastUpdateLogin": "8A5689AE12D939D9E05322EAF40A63A4",
"LastUpdatedBy": "CONMGR",
...
}

115 | P a g e
 Subscription Management REST Documentation

Update a Covered Level Charge Adjustment

Method: POST

URI:
/crmRestApi/resources/[Link]/subscriptions/{SubscriptionPUID}/child/products/{SubscriptionProd
uctPUID}/child/charges/{ChargePUID}/child/adjustments/{ChargeAdjustmentPUID}

Media Type: application/[Link]+json, application/json

Example:

[Link]
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:

{
"ChargeAdjustmentId": 300100177242432,
"ChargeAdjustmentPuid": "GP-5678-PRDT-1-CHRG-9-MADJ-1",
"ChargeId": 300100177231506,
"PeriodFrom": null,
"PeriodUntil": null,
"AdjustmentType": "ORA_DISCOUNT_AMOUNT",
"AdjustmentValue": 600,
"AdjustmentBasis": null,
"Reason": "Special offer",
"SequenceNumber": 1,
"SubscriptionId": 300100177254423,
"SubscriptionProductId": 300100177254429,
"AdjustmentName": "One Time Off",
"AutoAdjustmentFlag": null,
"Effectivity": "ORA_ALL_TERM",
"NumberOfPeriods": null,
"ObjectVersionNumber": 1,
"CreatedBy": "CONMGR",
"CreationDate": "2019-06-04T14:06:49+00:00",
"LastUpdateDate": "2019-06-04T14:06:49.706+00:00",
"LastUpdateLogin": "8A5689BEEA6839CBE05322EAF40A0656",
"LastUpdatedBy": "CONMGR",
...
}

116 | P a g e
 Subscription Management REST Documentation

Delete a Covered Level Charge Adjustment

Method: DELETE

URI:
/crmRestApi/resources/[Link]/subscriptions/{SubscriptionPUID}/child/products/{SubscriptionProd
uctPUID}/child/coveredLevels/{CoveredLevelPUID}/child/charges/{ChargePUID}/child/adjustments/{Adj
ustmentPUID}

Media Type: application/[Link]+json, application/json

Example:

[Link]
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/GP-7788-PRDT-13-CHRG-29-MADJ-3

Response Body:

Blank

Status: 204 No Content

Get a Covered Level Charge Adjustment

Method: GET

URI:
/crmRestApi/resources/[Link]/subscriptions/{SubscriptionPUID}/child/products/{SubscriptionProd
uctPUID}/child/coveredLevels/{CoveredLevelPUID}/child/charges/{ChargePUID}/child/adjustments/{Adj
ustmentPUID}

Media Type: application/[Link]+json, application/json

Example:

[Link]
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/GP-7788-PRDT-13-CHRG-29-MADJ-3

Response Body:

{
"ChargeAdjustmentId": 300100177232519,

117 | P a g e
 Subscription Management REST Documentation

"ChargeAdjustmentPuid": "GP-7788-PRDT-13-CHRG-29-MADJ-3",
"ChargeId": 300100177242683,
"PeriodFrom": null,
"PeriodUntil": null,
"AdjustmentType": "ORA_DISCOUNT_PERCENT",
"AdjustmentValue": 500,
"AdjustmentBasis": "ORA_LIST_PRICE",
"Reason": "Special seasonal offer",
"SequenceNumber": 1,
"SubscriptionId": 300100177232478,
"SubscriptionProductId": 300100177232481,
"AdjustmentName": "One-time Discount",
"AutoAdjustmentFlag": false,
"Effectivity": "ORA_ALL_TERM",
"NumberOfPeriods": null,
"ObjectVersionNumber": 1,
"CreatedBy": "CONMGR",
"CreationDate": "2019-06-05T07:59:13.728+00:00",
"LastUpdateDate": "2019-06-05T07:59:36.252+00:00",
"LastUpdateLogin": "8A568ABC72F139D7E05322EAF40A0F90",
"LastUpdatedBy": "CONMGR",
...
}

Get Covered Level Charge Adjustments

Method: GET

URI:
/crmRestApi/resources/[Link]/subscriptions/{SubscriptionPUID}/child/products/{SubscriptionProd
uctPUID}/child/coveredLevels/{CoveredLevelPUID}/child/charges/{ChargePUID}/child/adjustments

Media Type: application/[Link]+json, application/json

Example:

[Link]
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/

Response Body:

{
"items": [
{
"ChargeAdjustmentId": 300100177232519,
"ChargeAdjustmentPuid": "GP-7788-PRDT-13-CHRG-29-MADJ-3",
"ChargeId": 300100177242683,
"PeriodFrom": null,
"PeriodUntil": null,
"AdjustmentType": "ORA_DISCOUNT_PERCENT",
"AdjustmentValue": 500,

118 | P a g e
 Subscription Management REST Documentation

"AdjustmentBasis": "ORA_LIST_PRICE",
"Reason": "Special seasonal offer",
"SequenceNumber": 1,
"SubscriptionId": 300100177232478,
"SubscriptionProductId": 300100177232481,
"AdjustmentName": "One-time Discount",
"AutoAdjustmentFlag": false,
"Effectivity": "ORA_ALL_TERM",
"NumberOfPeriods": null,
"ObjectVersionNumber": 1,
"CreatedBy": "CONMGR",
"CreationDate": "2019-06-05T07:59:13.728+00:00",
"LastUpdateDate": "2019-06-05T07:59:36.252+00:00",
"LastUpdateLogin": "8A568ABC72F139D7E05322EAF40A0F90",
"LastUpdatedBy": "CONMGR",
…
}
],
"count": 1,
"hasMore": false,
"limit": 25,
"offset": 0,
...
}

Subscription Covered Level Bill Lines

Create a Covered Level Bill Line

Method: POST

URI:
/crmRestApi/resources/[Link]/subscriptions/{SubscriptionPUID}/child/products/{SubscriptionProd
uctPUID}/child/coveredLevels/{CoveredLevelPUID}/child/billLines

Media Type: application/[Link]+json, application/json

Example:

[Link]
5678/child/products/GP-5678-PRDT-1/child/billLines

Request Body:

{
"BillLinePuid": "GP-7788-PRDT-13-BILL-879",
"ChargeId": 300100177232491,
"BillingPeriod": 1,
"DateToInterface": "2019-06-05",

119 | P a g e
 Subscription Management REST Documentation

"DateBilledFrom": "2019-01-01",
"DateBilledTo": "2019-01-31",
"Amount": 200,
"RecurringFlag": true,
"UsageFlag": false,
"UsagePricedFlag": true,
"InterfacedFlag": false,
"TransactionClass": "INV",
"InvoiceText": "ZOKC_COVG_MPA_Item: ZOKC_SK_RECURRINGCHARGE 2019-
01-01-2019-01-31",
"ChargePeriod": 1,
"ListPrice": 200
}

Response Body:

{
"BillLineId": 100100108506361,
"BillLinePuid": "GP-7788-PRDT-13-BILL-879",
"SubscriptionId": 300100177232478,
"SubscriptionProductId": 300100177232481,
"CoveredLevelId": 300100177232486,
"ChargeId": 300100177242683,
"ChargePuid": null,
"BillingPeriod": 0,
"DateToInterface": "2019-06-05",
"DateBilledFrom": "2019-01-01",
"DateBilledTo": "2019-12-31",
"Amount": 0,
"RecurringFlag": false,
"UsageFlag": false,
"UsageAcquiredFlag": null,
"UsagePricedFlag": true,
"InterfacedFlag": false,
"TransactionClass": "INV",
"TransactionDate": null,
"TransactionNumber": null,
"TransactionTax": null,
"TransactionAmount": null,
"InvoiceText": "ZOKC_COVG_MPA_Item: Sale Price 2019-01-01-2019-12-31",
"InvoiceBillLineId": null,
"UsageCaptureDate": null,
"UsageQuantity": null,
"ChargePeriod": 0,
"PricingError": null,
"ListPrice": 9000,
"RevenueLineId": null,
"CreatedBy": "CONMGR",
"CreationDate": "2019-06-05T07:59:37+00:00",
"LastUpdatedBy": "CONMGR",
"LastUpdateDate": "2019-06-05T07:59:37+00:00",
"LastUpdateLogin": "8A568ABC72F139D7E05322EAF40A0F90",
"TransactionClassMeaning": "Invoice",
"InvoiceDate": "2019-06-05",
"NewCreditMemoPUID": null,
"CreditMemoAmount": null,

120 | P a g e
 Subscription Management REST Documentation

"CreditMemoFlag": null,
"CreditMemoReason": null,
...
}

Update a Covered Level Bill Line

Method: PATCH

URI:
/crmRestApi/resources/[Link]/subscriptions/{SubscriptionPUID}/child/products/{SubscriptionProd
uctPUID}/child/coveredLevels/{CoveredLevelPUID}/child/billLines/{BillLinePUID}

Media Type: application/[Link]+json, application/json

Example:

[Link]
7788/child/products/GP-7788-PRDT-13/child/coveredLevels/GP-7788-PRDT-13-PASS-
5/child/billLines/GP-7788-PRDT-13-BILL-881

Request Body:

{
"Amount": 200
}

Response Body:

{
"BillLineId": 100100108506380,
"BillLinePuid": "GP-7788-PRDT-13-BILL-881",
"SubscriptionId": 300100177232478,
"SubscriptionProductId": 300100177232481,
"CoveredLevelId": 300100177232486,
"ChargeId": 300100177232491,
"ChargePuid": null,
"BillingPeriod": 1,
"DateToInterface": "2019-06-05",
"DateBilledFrom": "2019-01-01",
"DateBilledTo": "2019-01-31",
"Amount": 200,
"RecurringFlag": true,
"UsageFlag": false,
"UsageAcquiredFlag": null,
"UsagePricedFlag": true,
"InterfacedFlag": false,
"TransactionClass": "INV",
"TransactionDate": null,
"TransactionNumber": null,

121 | P a g e
 Subscription Management REST Documentation

"TransactionTax": null,
"TransactionAmount": null,
"InvoiceText": "ZOKC_COVG_MPA_Item: ZOKC_SK_RECURRINGCHARGE 2019-01-01-
2019-01-31",
"InvoiceBillLineId": null,
"UsageCaptureDate": null,
"UsageQuantity": null,
"ChargePeriod": 1,
"PricingError": null,
"ListPrice": 200,
"RevenueLineId": null,
"CreatedBy": "CONMGR",
"CreationDate": "2019-06-05T07:59:37+00:00",
"LastUpdatedBy": "CONMGR",
"LastUpdateDate": "2019-06-05T10:47:26.012+00:00",
"LastUpdateLogin": "8A5689AE12D939D9E05322EAF40A63A4",
"TransactionClassMeaning": "Invoice",
"InvoiceDate": "2019-06-05",
"NewCreditMemoPUID": null,
"CreditMemoAmount": null,
"CreditMemoFlag": null,
"CreditMemoReason": null,
...
}

Delete a Covered Level Bill Line

Method: DELETE

URI:
/crmRestApi/resources/[Link]/subscriptions/{SubscriptionPUID}/child/products/{SubscriptionProd
uctPUID}/child/coveredLevels/{CoveredLevelPUID}/child/billLines/{BillLinePUID}

Media Type: application/[Link]+json, application/json

Example:

[Link]
5678/child/products/GP-5678-PRDT-1/child/billLines/GP-5678-PRDT-1-BILL-309

Response Body:

Blank

Status: 204 No Content

Get a Covered Level Bill Line

122 | P a g e
 Subscription Management REST Documentation

Method: GET

URI:
/crmRestApi/resources/[Link]/subscriptions/{SubscriptionPUID}/child/products/{SubscriptionProd
uctPUID}/child/coveredLevel/{CoveredLevelPUID}/child/billLines/{BillLinePUID}

Media Type: application/[Link]+json, application/json

Example:

[Link]
7788/child/products/GP-7788-PRDT-13/child/coveredLevels/GP-7788-PRDT-13-PASS-
5/child/billLines/GP-7788-PRDT-13-BILL-879

Response Body:

{
"BillLineId": 100100108506361,
"BillLinePuid": "GP-7788-PRDT-13-BILL-879",
"SubscriptionId": 300100177232478,
"SubscriptionProductId": 300100177232481,
"CoveredLevelId": 300100177232486,
"ChargeId": 300100177242683,
"ChargePuid": null,
"BillingPeriod": 0,
"DateToInterface": "2019-06-05",
"DateBilledFrom": "2019-01-01",
"DateBilledTo": "2019-12-31",
"Amount": 0,
"RecurringFlag": false,
"UsageFlag": false,
"UsageAcquiredFlag": null,
"UsagePricedFlag": true,
"InterfacedFlag": false,
"TransactionClass": "INV",
"TransactionDate": null,
"TransactionNumber": null,
"TransactionTax": null,
"TransactionAmount": null,
"InvoiceText": "ZOKC_COVG_MPA_Item: Sale Price 2019-01-01-2019-12-31",
"InvoiceBillLineId": null,
"UsageCaptureDate": null,
"UsageQuantity": null,
"ChargePeriod": 0,
"PricingError": null,
"ListPrice": 9000,
"RevenueLineId": null,
"CreatedBy": "CONMGR",
"CreationDate": "2019-06-05T07:59:37+00:00",
"LastUpdatedBy": "CONMGR",
"LastUpdateDate": "2019-06-05T07:59:37+00:00",
"LastUpdateLogin": "8A568ABC72F139D7E05322EAF40A0F90",
"TransactionClassMeaning": "Invoice",
"InvoiceDate": "2019-06-05",

123 | P a g e
 Subscription Management REST Documentation

"NewCreditMemoPUID": null,
"CreditMemoAmount": null,
"CreditMemoFlag": null,
"CreditMemoReason": null,
...
}

Get Covered Level Bill Lines

Method: GET

URI:
/crmRestApi/resources/[Link]/subscriptions/{SubscriptionPUID}/child/products/{SubscriptionProd
uctPUID}/child/coveredLevels/{CoveredLevelPUID}/child/billLines

Media Type: application/[Link]+json, application/json

Example:

[Link]
7788/child/products/GP-7788-PRDT-13/child/coveredLevels/GP-7788-PRDT-13-PASS-5/child/billLines/

Response Body:

{
"items": [
{
"BillLineId": 100100108506361,
"BillLinePuid": "GP-7788-PRDT-13-BILL-879",
"SubscriptionId": 300100177232478,
"SubscriptionProductId": 300100177232481,
"CoveredLevelId": 300100177232486,
"ChargeId": 300100177242683,
"ChargePuid": null,
"BillingPeriod": 0,
"DateToInterface": "2019-06-05",
"DateBilledFrom": "2019-01-01",
"DateBilledTo": "2019-12-31",
"Amount": 0,
"RecurringFlag": false,
"UsageFlag": false,
"UsageAcquiredFlag": null,
"UsagePricedFlag": true,
"InterfacedFlag": false,
"TransactionClass": "INV",
"TransactionDate": null,
"TransactionNumber": null,
"TransactionTax": null,
"TransactionAmount": null,
"InvoiceText": "ZOKC_COVG_MPA_Item: Sale Price 2019-01-01-2019-
12-31",

124 | P a g e
 Subscription Management REST Documentation

"InvoiceBillLineId": null,
"UsageCaptureDate": null,
"UsageQuantity": null,
"ChargePeriod": 0,
"PricingError": null,
"ListPrice": 9000,
"RevenueLineId": null,
"CreatedBy": "CONMGR",
"CreationDate": "2019-06-05T07:59:37+00:00",
"LastUpdatedBy": "CONMGR",
"LastUpdateDate": "2019-06-05T07:59:37+00:00",
"LastUpdateLogin": "8A568ABC72F139D7E05322EAF40A0F90",
"TransactionClassMeaning": "Invoice",
"InvoiceDate": "2019-06-05",
"NewCreditMemoPUID": null,
"CreditMemoAmount": null,
"CreditMemoFlag": null,
"CreditMemoReason": null,
...
},
...
],
"count": 13,
"hasMore": false,
"limit": 25,
"offset": 0,
...
}

Subscription Covered Level Bill Line Adjustments

Create a Covered Level Bill Line Adjustment

Method: POST

URI:
/crmRestApi/resources/[Link]/subscriptions/{SubscriptionPUID}/child/products/{SubscriptionProd
uctPUID}/child/coveredLevels/{CoveredLevelPUID}/child/billLines/{BillLinePUID}/child/billAdjustments

Media Type: application/[Link]+json, application/json

Example:

[Link]
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
 Subscription Management REST Documentation

"ChargeAdjustmentId": 300100177232518,
"AdjustmentName": "One time discount",
"AdjustmentValue": 50,
"AdjustmentType": "ORA_DISCOUNT_AMOUNT",
"AdjustmentBasis": "ORA_LIST_PRICE",
"Effectivity": "ORA_ALL_TERM",
"SequenceNumber": 1,
"AutoAdjustmentFlag": false
}

Response Body:

{
"BillAdjustmentId": 300100177242686,
"SubscriptionId": 300100177232478,
"SubscriptionProductId": 300100177232481,
"BillLineId": 100100108507019,
"BillAdjustmentPuid": "GP-7788-PRDT-13-BILL-931-BADJ-38",
"ChargeAdjustmentId": 300100177232518,
"AdjustmentName": "One time discount",
"AdjustmentValue": 50,
"AdjustmentType": "ORA_DISCOUNT_AMOUNT",
"AdjustmentBasis": "ORA_LIST_PRICE",
"Reason": null,
"Effectivity": "ORA_ALL_TERM",
"NumberOfPeriods": null,
"PeriodFrom": null,
"PeriodUntil": null,
"SequenceNumber": 3,
"AutoAdjustmentFlag": false,
"CreatedBy": "CONMGR",
"CreationDate": "2019-06-05T11:12:52+00:00",
"LastUpdatedBy": "CONMGR",
"LastUpdateDate": "2019-06-05T11:12:52.109+00:00",
"LastUpdateLogin": "8A5689AE12D939D9E05322EAF40A63A4",
"CurrencyCode": null,
"BasisEnableFlag": "false",
...
}

Update a Covered Level Bill Line Adjustment

Method: POST

URI:
/crmRestApi/resources/[Link]/subscriptions/{SubscriptionPUID}/child/products/{SubscriptionProd
uctPUID}/child/coveredLevels/{CoveredLevelPUID}/child/billLines/{BillLinePUID}/child/billAdjustments/{
BillAdjustmentPUID}

Media Type: application/[Link]+json, application/json

126 | P a g e
 Subscription Management REST Documentation

Example:

[Link]
7788/child/products/GP-7788-PRDT-13/child/coveredLevels/GP-7788-PRDT-13-PASS-
5/child/billLines/GP-7788-PRDT-13-BILL-931/child/billAdjustments/GP-7788-PRDT-13-BILL-931-BADJ-38

Request Body:

{
"AdjustmentValue": 60,
"AdjustmentType": "ORA_DISCOUNT_AMOUNT"
}

Response Body:

{
"BillAdjustmentId": 300100177242686,
"SubscriptionId": 300100177232478,
"SubscriptionProductId": 300100177232481,
"BillLineId": 100100108507019,
"BillAdjustmentPuid": "GP-7788-PRDT-13-BILL-931-BADJ-38",
"ChargeAdjustmentId": 300100177232518,
"AdjustmentName": "One time discount",
"AdjustmentValue": 60,
"AdjustmentType": "ORA_DISCOUNT_AMOUNT",
"AdjustmentBasis": "ORA_LIST_PRICE",
"Reason": null,
"Effectivity": "ORA_ALL_TERM",
"NumberOfPeriods": null,
"PeriodFrom": null,
"PeriodUntil": null,
"SequenceNumber": 3,
"AutoAdjustmentFlag": false,
"CreatedBy": "CONMGR",
"CreationDate": "2019-06-05T11:12:52+00:00",
"LastUpdatedBy": "CONMGR",
"LastUpdateDate": "2019-06-05T11:14:30+00:00",
"LastUpdateLogin": "8A5689AE12D939D9E05322EAF40A63A4",
"CurrencyCode": null,
"BasisEnableFlag": "false",
...
}

Delete a Covered Level Bill Line Adjustment

Method: DELETE

URI:
/crmRestApi/resources/[Link]/subscriptions/{SubscriptionPUID}/child/products/{SubscriptionProd

127 | P a g e
 Subscription Management REST Documentation

uctPUID}/child/coveredLevels/{CoveredLevelPUID}/child/billLines/{BillLinePUID}/child/billAdjustments/{
BillAdjustmentPUID}

Media Type: application/[Link]+json, application/json

Example:

[Link]
7788/child/products/GP-7788-PRDT-13/child/coveredLevels/GP-7788-PRDT-13-PASS-
5/child/billLines/GP-7788-PRDT-13-BILL-931/child/billAdjustments/GP-7788-PRDT-13-BILL-931-BADJ-38

Response Body:

Blank

Status: 204 Not Content

Get a Covered Level Bill Line Adjustments

Method: GET

URI:
/crmRestApi/resources/[Link]/subscriptions/{SubscriptionPUID}/child/products/{SubscriptionProd
uctPUID}/child/coveredLevels/{CoveredLevelPUID}/child/billLines/{BillLinePUID}/child/billAdjustments/{
BillAdjustmentPUID}

Media Type: application/[Link]+json, application/json

Example:

[Link]
7788/child/products/GP-7788-PRDT-13/child/coveredLevels/GP-7788-PRDT-13-PASS-
5/child/billLines/GP-7788-PRDT-13-BILL-931/child/billAdjustments/GP-7788-PRDT-13-BILL-931-BADJ-38

Response Body:

{
"BillAdjustmentId": 100100108507147,
"SubscriptionId": 300100177232478,
"SubscriptionProductId": 300100177232481,
"BillLineId": 100100108507019,
"BillAdjustmentPuid": "GP-7788-PRDT-13-BILL-931-BADJ-38",
"ChargeAdjustmentId": 300100177232518,
"AdjustmentName": "One time discount",
"AdjustmentValue": 50,
"AdjustmentType": "ORA_DISCOUNT_AMOUNT",

128 | P a g e
 Subscription Management REST Documentation

"AdjustmentBasis": null,
"Reason": null,
"Effectivity": "ORA_ALL_TERM",
"NumberOfPeriods": null,
"PeriodFrom": null,
"PeriodUntil": null,
"SequenceNumber": 1,
"AutoAdjustmentFlag": false,
"CreatedBy": "CONMGR",
"CreationDate": "2019-06-05T10:58:18+00:00",
"LastUpdatedBy": "CONMGR",
"LastUpdateDate": "2019-06-05T10:58:18+00:00",
"LastUpdateLogin": "8A568A61F0F3BE1AE05323EAF40A9340",
"CurrencyCode": null,
"BasisEnableFlag": "false",
...
}

Get Covered Level Bill Line Adjustments

Method: GET

URI:
/crmRestApi/resources/[Link]/subscriptions/{SubscriptionPUID}/child/products/{SubscriptionProd
uctPUID}/child/coveredLevels/{CoveredLevelPUID}/child/billLines/{BillLinePUID}/child/billAdjustments

Media Type: application/[Link]+json, application/json

Example:

[Link]
7788/child/products/GP-7788-PRDT-13/child/coveredLevels/GP-7788-PRDT-13-PASS-
5/child/billLines/GP-7788-PRDT-13-BILL-931/child/billAdjustments

Response Body:

{
"items": [
{
"BillAdjustmentId": 100100108507147,
"SubscriptionId": 300100177232478,
"SubscriptionProductId": 300100177232481,
"BillLineId": 100100108507019,
"BillAdjustmentPuid": "GP-7788-PRDT-13-BILL-931-BADJ-38",
"ChargeAdjustmentId": 300100177232518,
"AdjustmentName": "One time discount",
"AdjustmentValue": 50,
"AdjustmentType": "ORA_DISCOUNT_AMOUNT",
"AdjustmentBasis": null,
"Reason": null,
"Effectivity": "ORA_ALL_TERM",

129 | P a g e
 Subscription Management REST Documentation

"NumberOfPeriods": null,
"PeriodFrom": null,
"PeriodUntil": null,
"SequenceNumber": 1,
"AutoAdjustmentFlag": false,
"CreatedBy": "CONMGR",
"CreationDate": "2019-06-05T10:58:18+00:00",
"LastUpdatedBy": "CONMGR",
"LastUpdateDate": "2019-06-05T10:58:18+00:00",
"LastUpdateLogin": "8A568A61F0F3BE1AE05323EAF40A9340",
"CurrencyCode": null,
"BasisEnableFlag": "false",
…
},
{
"BillAdjustmentId": 300100177231599,
"SubscriptionId": 300100177232478,
"SubscriptionProductId": 300100177232481,
"BillLineId": 100100108507019,
"BillAdjustmentPuid": "GP-7788-PRDT-13-BADJ-42",
"ChargeAdjustmentId": null,
"AdjustmentName": "One off discount",
"AdjustmentValue": 50,
"AdjustmentType": "ORA_DISCOUNT_AMOUNT",
"AdjustmentBasis": "ORA_LIST_PRICE",
"Reason": "Special discount",
"Effectivity": null,
"NumberOfPeriods": null,
"PeriodFrom": null,
"PeriodUntil": null,
"SequenceNumber": 2,
"AutoAdjustmentFlag": false,
"CreatedBy": "CONMGR",
"CreationDate": "2019-06-05T10:59:31.544+00:00",
"LastUpdatedBy": "CONMGR",
"LastUpdateDate": "2019-06-05T11:01:13.360+00:00",
"LastUpdateLogin": "8A568A61F0F3BE1AE05323EAF40A9340",
"CurrencyCode": null,
"BasisEnableFlag": "false",
…
}
],
"count": 2,
"hasMore": false,
"limit": 25,
"offset": 0,
...
}

Asset Transactions

130 | P a g e
 Subscription Management REST Documentation

Asset Creation

ALM (Installed Base) REST

Method: POST

URI: /fscmRestApi/resources/latest/customerAssets

Media Type: application/[Link]+json, application/json

Example:

[Link]

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,
"AssetNumber": "Ballet002",
"CurrentLocationContext": "ORA_CUSTOMER",
"CurrentLocationId": null,
"CustomerAccountId": 1006,
"CustomerAccountSiteId": null,
"CustomerAccountSiteUseId": 10921,
"CustomerBillingPartyId": 1006,
"CustomerBillingPartySiteId": null,
"CustomerId": 1006,
"CustomerSiteId": null,
"CustomerSitePartyId": null,
"Description": "Ballet002",
"ItemId": 300100172651968,
"ItemOrganizationId": 204,
"ItemRevision": null,
"LotNumber": null,
"MaintainableFlag": true,

131 | P a g e
 Subscription Management REST Documentation

"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
 Subscription Management REST Documentation

Media Type: application/[Link]+json, application/json

Example:

[Link]
ions

Request Body:

"TransactionType": "CUSTOMER_ASSET_CREATION",
"TransactionDate": "2020-01-26",
"AssetId": 300100184794815,
"Quantity": 1,
"CustomerId": 1006,
"BillToAccountId": 1006,
"BillToAccountSiteUseId":10921
}

Response Body:

{
"TransactionId": 300100184619027,
"TransactionNumber": "ATXN-2011",
"TransactionSequence": 3003,
"TransactionType": "CUSTOMER_ASSET_CREATION",
"TransactionDate": "2020-01-26",
"TransactionStatus": "PENDING",
"AssetId": 300100184794815,
"Quantity": 1,
"BusinessUnitId": null,
"CustomerId": 1006,
"BillToAccountId": 1006,
"BillToAccountSiteId": null,
"BillToAccountSiteUseId": 10921,
"ShipToPartyId": null,
"ShipToPartySiteId": null,
"SalesOrderSystem": null,
"SalesOrderId": null,
"SalesOrderLineId": null,
"SalesOrderNumber": null,
"SalesOrderLineNumber": null,
"ReturnOrderSystem": null,
"ReturnOrderId": null,
"ReturnOrderLineId": null,
"ReturnOrderNumber": null,
"ReturnOrderLineNumber": null,
"ReplacementAssetId": null,
"FulfillmentType": null,
"WaitForFulfillment": null,
"PendingFulfillmentCancelled": null,

133 | P a g e
 Subscription Management REST Documentation

"ShipmentCompleted": null,
"ReturnCompleted": null,
"CreatedBy": "CONMGR",
"CreationDate": "2020-01-27T08:07:47+00:00",
"LastUpdatedBy": "CONMGR",
"LastUpdateDate": "2020-01-27T08:07:47.165+00:00",
"LastUpdateLogin": "9CD6511C8B4A69F9E05323EAF40AFA3C",
"links": [
...
]
}

Asset Expiration

ALM (Installed Base) REST

Method: PATCH

URI: /fscmRestApi/resources/latest/customerAssets/{AssetID}

Media Type: application/[Link]+json, application/json

Example:

[Link]
184794815

Request Body:

{
"CustomerAssetEndDate”: "2020-01-27",
"UpdateContractFlag":"N"
}

Response Body:

"ActiveEndDate": null,
"AssetId": 300100184794815,
"AssetNumber": "Ballet002",
"CurrentLocationContext": "ORA_CUSTOMER",
"CurrentLocationId": null,
"CustomerAccountId": 1006,
"CustomerAccountSiteId": null,
"CustomerAccountSiteUseId": 10921,
"CustomerBillingPartyId": 1006,
"CustomerBillingPartySiteId": null,
"CustomerId": 1006,
"CustomerSiteId": null,
"CustomerSitePartyId": null,

134 | P a g e
 Subscription Management REST Documentation

"Description": "Ballet002",
"ItemId": 300100172651968,
"ItemOrganizationId": 204,
"ItemRevision": null,
"LotNumber": null,
"MaintainableFlag": true,
"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": "Ballet PC 2018",
"OrganizationCode": null,
"CurrentLocationName": "Customer address",
"UpdateContractFlag": false,
"SourceTransactionDate": "2020-01-27T08:16:07.898+00:00",
"SoldByBusinessUnitName": null,
"CustomerName": "Computer Service and Rentals",
"CustomerNumber": "1006",
"CustomerSitePartyName": null,
"CustomerSitePartyNumber": null,
"CustomerSiteName": null,
"CustomerSiteNumber": null,
"CustomerAccountName": "Computer Service and Rentals",
"CustomerAccountNumber": "1006",
"CustomerAccountSiteName": null,
"CustomerAccountSiteNumber": null,
"CustomerAccountSiteUseCode": null,
"CustomerAssetEndDate": "2020-01-27T00:00:00+00:00",
"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

135 | P a g e
 Subscription Management REST Documentation

Method: POST

URI: /crmRestApi/resources/latest/subscriptionAssetTransactions

Media Type: application/[Link]+json, application/json

Example:

[Link]
ions

Request Body:

{
"TransactionType": "CUSTOMER_ASSET_EXPIRATION",
"TransactionDate": "2020-01-27",
"AssetId": 300100184794815
}

Request Body:

{
"TransactionId": 300100184619029,
"TransactionNumber": "ATXN-2012",
"TransactionSequence": 3004,
"TransactionType": "CUSTOMER_ASSET_EXPIRATION",
"TransactionDate": "2020-01-27",
"TransactionStatus": "PENDING",
"AssetId": 300100184794815,
"Quantity": null,
"BusinessUnitId": null,
"CustomerId": null,
"BillToAccountId": null,
"BillToAccountSiteId": null,
"BillToAccountSiteUseId": null,
"ShipToPartyId": null,
"ShipToPartySiteId": null,
"SalesOrderSystem": null,
"SalesOrderId": null,
"SalesOrderLineId": null,
"SalesOrderNumber": null,
"SalesOrderLineNumber": null,
"ReturnOrderSystem": null,
"ReturnOrderId": null,
"ReturnOrderLineId": null,
"ReturnOrderNumber": null,
"ReturnOrderLineNumber": null,
"ReplacementAssetId": null,
"FulfillmentType": null,
"WaitForFulfillment": null,
"PendingFulfillmentCancelled": null,
"ShipmentCompleted": null,

136 | P a g e
 Subscription Management REST Documentation

"ReturnCompleted": null,
"CreatedBy": "CONMGR",
"CreationDate": "2020-01-27T08:22:13+00:00",
"LastUpdatedBy": "CONMGR",
"LastUpdateDate": "2020-01-27T08:22:13.126+00:00",
"LastUpdateLogin": "9CD631BAFCFB801EE05322EAF40A0665",
"links": [
...
]
}

Asset Reinstation

ALM (Installed Base) REST

Method: PATCH

URI: /fscmRestApi/resources/latest/customerAssets/{AssetID}

Media Type: application/[Link]+json, application/json

Example:

[Link]
184794815

Request Body:

{
"CustomerAssetEndDate" : null,
"UpdateContractFlag":"N"
}

{
"ActiveEndDate": null,
"AssetId": 300100184794815,
"AssetNumber": "Ballet002",
"CurrentLocationContext": "ORA_CUSTOMER",
"CurrentLocationId": null,
"CustomerAccountId": 1006,
"CustomerAccountSiteId": null,
"CustomerAccountSiteUseId": 10921,
"CustomerBillingPartyId": 1006,
"CustomerBillingPartySiteId": null,
"CustomerId": 1006,
"CustomerSiteId": null,
"CustomerSitePartyId": null,
"Description": "Ballet002",
"ItemId": 300100172651968,

137 | P a g e
 Subscription Management REST Documentation

"ItemOrganizationId": 204,
"ItemRevision": null,
"LotNumber": null,
"MaintainableFlag": true,
"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": "Ballet PC 2018",
"OrganizationCode": null,
"CurrentLocationName": "Customer address",
"UpdateContractFlag": false,
"SourceTransactionDate": "2020-01-27T08:40:14.441+00:00",
"SoldByBusinessUnitName": null,
"CustomerName": "Computer Service and Rentals",
"CustomerNumber": "1006",
"CustomerSitePartyName": null,
"CustomerSitePartyNumber": null,
"CustomerSiteName": null,
"CustomerSiteNumber": null,
"CustomerAccountName": "Computer Service and Rentals",
"CustomerAccountNumber": "1006",
"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

138 | P a g e
 Subscription Management REST Documentation

URI: /crmRestApi/resources/latest/subscriptionAssetTransactions

Media Type: application/[Link]+json, application/json

Example:

[Link]
ions

Request Body:

{
"TransactionType": "CUSTOMER_ASSET_REINSTATE",
"TransactionDate": "2020-01-27",
"AssetId": 300100184794815
}

Response Body:

{
"TransactionId": 300100184802491,
"TransactionNumber": "ATXN-2014",
"TransactionSequence": 3005,
"TransactionType": "CUSTOMER_ASSET_REINSTATE",
"TransactionDate": "2020-01-27",
"TransactionStatus": "WARNING",
"AssetId": 300100184794815,
"Quantity": null,
"BusinessUnitId": null,
"CustomerId": null,
"BillToAccountId": null,
"BillToAccountSiteId": null,
"BillToAccountSiteUseId": null,
"ShipToPartyId": null,
"ShipToPartySiteId": null,
"SalesOrderSystem": null,
"SalesOrderId": null,
"SalesOrderLineId": null,
"SalesOrderNumber": null,
"SalesOrderLineNumber": null,
"ReturnOrderSystem": null,
"ReturnOrderId": null,
"ReturnOrderLineId": null,
"ReturnOrderNumber": null,
"ReturnOrderLineNumber": null,
"ReplacementAssetId": null,
"FulfillmentType": null,
"WaitForFulfillment": null,
"PendingFulfillmentCancelled": null,
"ShipmentCompleted": null,
"ReturnCompleted": null,
"CreatedBy": "CONMGR",
"CreationDate": "2020-01-27T08:44:05+00:00",

139 | P a g e
 Subscription Management REST Documentation

"LastUpdatedBy": "CONMGR",
"LastUpdateDate": "2020-01-27T08:44:05.149+00:00",
"LastUpdateLogin": "9CD64491F91069E5E05323EAF40AC27C",
"links": [
...
}

Asset Transfer

Subscription REST

Method: POST

URI: /crmRestApi/resources/latest/subscriptionAssetTransactions

Media Type: application/[Link]+json, application/json

Example:

[Link]
ions

Request Body:

{
"TransactionType": "CUSTOMER_ASSET_TRANSFER",
"TransactionDate": "2020-01-27",
"AssetId": 300100168051605,
"CustomerId": 1005,
"BillToAccountId": 1005,
"BillToAccountSiteUseId": 1023
}

Response Body:

{
"TransactionId": 300100184802493,
"TransactionNumber": "ATXN-2017",
"TransactionSequence": 3006,
"TransactionType": "CUSTOMER_ASSET_TRANSFER",
"TransactionDate": "2020-01-27",
"TransactionStatus": "WARNING",
"AssetId": 300100184794815,
"Quantity": null,
"BusinessUnitId": null,
"CustomerId": 1005,
"BillToAccountId": 1005,
"BillToAccountSiteId": null,
"BillToAccountSiteUseId": 1023,
"ShipToPartyId": null,

140 | P a g e
 Subscription Management REST Documentation

"ShipToPartySiteId": null,
"SalesOrderSystem": null,
"SalesOrderId": null,
"SalesOrderLineId": null,
"SalesOrderNumber": null,
"SalesOrderLineNumber": null,
"ReturnOrderSystem": null,
"ReturnOrderId": null,
"ReturnOrderLineId": null,
"ReturnOrderNumber": null,
"ReturnOrderLineNumber": null,
"ReplacementAssetId": null,
"FulfillmentType": null,
"WaitForFulfillment": null,
"PendingFulfillmentCancelled": null,
"ShipmentCompleted": null,
"ReturnCompleted": null,
"CreatedBy": "CONMGR",
"CreationDate": "2020-01-27T09:01:31+00:00",
"LastUpdatedBy": "CONMGR",
"LastUpdateDate": "2020-01-27T09:01:31.056+00:00",
"LastUpdateLogin": "9CD64491F91069E5E05323EAF40AC27C",
"links": [
...
]
}

Asset Return

Subscription REST

Method: POST

URI: /crmRestApi/resources/latest/subscriptionAssetTransactions

Media Type: application/[Link]+json, application/json

Example:

[Link]
ions

Request Body:

{
"TransactionType": "CUSTOMER_ASSET_RETURN",
"TransactionDate": "2020-01-27",
"AssetId": 300100184794815
}
Response Body:

141 | P a g e
 Subscription Management REST Documentation

{
"TransactionId": 300100184802495,
"TransactionNumber": "ATXN-2018",
"TransactionSequence": 3007,
"TransactionType": "CUSTOMER_ASSET_RETURN",
"TransactionDate": "2020-01-27",
"TransactionStatus": "WARNING",
"AssetId": 300100184794815,
"Quantity": null,
"BusinessUnitId": null,
"CustomerId": null,
"BillToAccountId": null,
"BillToAccountSiteId": null,
"BillToAccountSiteUseId": null,
"ShipToPartyId": null,
"ShipToPartySiteId": null,
"SalesOrderSystem": null,
"SalesOrderId": null,
"SalesOrderLineId": null,
"SalesOrderNumber": null,
"SalesOrderLineNumber": null,
"ReturnOrderSystem": null,
"ReturnOrderId": null,
"ReturnOrderLineId": null,
"ReturnOrderNumber": null,
"ReturnOrderLineNumber": null,
"ReplacementAssetId": null,
"FulfillmentType": null,
"WaitForFulfillment": null,
"PendingFulfillmentCancelled": null,
"ShipmentCompleted": null,
"ReturnCompleted": null,
"CreatedBy": "CONMGR",
"CreationDate": "2020-01-27T09:08:03+00:00",
"LastUpdatedBy": "CONMGR",
"LastUpdateDate": "2020-01-27T09:08:03.015+00:00",
"LastUpdateLogin": "9CD64491F91069E5E05323EAF40AC27C",
"links": [
...
]
}

Asset Split

ALM (Installed Base) REST

Method: POST

URI: /fscmRestApi/resources/latest/customerAssets

142 | P a g e
 Subscription Management REST Documentation

Media Type: application/[Link]+json, application/json

Example:

[Link]

Request Body:

{
"AssetNumber": "Ballet003",
"Description": "Ballet003",
"CustomerId": 1006,
"CustomerAccountId" : 1006,
"CustomerAccountSiteUseId" : 10921,
"ItemId": 300100172651968,
"ItemOrganizationId": 204,
"Quantity": 100,
"UpdateContractFlag":"Y",
"ShipmentDate": "2020-01-30"
}

Response Body:
{
"ActiveEndDate": null,
"AssetId": 300100184914074,
"AssetNumber": "Ballet003",
"CurrentLocationContext": "ORA_CUSTOMER",
"CurrentLocationId": null,
"CustomerAccountId": 1006,
"CustomerAccountSiteId": null,
"CustomerAccountSiteUseId": 10921,
"CustomerBillingPartyId": 1006,
"CustomerBillingPartySiteId": null,
"CustomerId": 1006,
"CustomerSiteId": null,
"CustomerSitePartyId": null,
"Description": "Ballet003",
"ItemId": 300100172651968,
"ItemOrganizationId": 204,
"ItemRevision": null,
"LotNumber": null,
"MaintainableFlag": true,
"NewWoAllowedFlag": true,
"Quantity": 100,
"SalesOrderId": null,
"SalesOrderLineId": null,
"SalesOrderLineNumber": null,
"SalesOrderNumber": null,
"SalesOrderSourceSystem": null,
"SalesOrderSourceSystemType": null,
"SerialNumber": null,
"ShipmentDate": "2020-01-30T00:00:00+00:00",
"SoldByBusinessUnitId": null,
"ItemNumber": null,
"OrganizationCode": null,

143 | P a g e
 Subscription Management REST Documentation

"CurrentLocationName": null,
"UpdateContractFlag": false,
"SourceTransactionDate": "2020-01-30T09:17:23.920+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-30T00: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": [
...
]
}

Method: PATCH

URI: /fscmRestApi/resources/latest/customerAssets/{Asset ID}

Media Type: application/[Link]+json, application/json

Example:

[Link]
184914074

Request Body:

{
"Quantity": 80,
"UpdateContractFlag":"N"
}

Response Body:

144 | P a g e
 Subscription Management REST Documentation

"ActiveEndDate": null,
"AssetId": 300100184914074,
"AssetNumber": "Ballet003",
"CurrentLocationContext": "ORA_CUSTOMER",
"CurrentLocationId": null,
"CustomerAccountId": 1006,
"CustomerAccountSiteId": null,
"CustomerAccountSiteUseId": 10921,
"CustomerBillingPartyId": 1006,
"CustomerBillingPartySiteId": null,
"CustomerId": 1006,
"CustomerSiteId": null,
"CustomerSitePartyId": null,
"Description": "Ballet003",
"ItemId": 300100172651968,
"ItemOrganizationId": 204,
"ItemRevision": null,
"LotNumber": null,
"MaintainableFlag": true,
"NewWoAllowedFlag": true,
"Quantity": 80,
"SalesOrderId": null,
"SalesOrderLineId": null,
"SalesOrderLineNumber": null,
"SalesOrderNumber": null,
"SalesOrderSourceSystem": null,
"SalesOrderSourceSystemType": null,
"SerialNumber": null,
"ShipmentDate": "2020-01-30T00:00:00+00:00",
"SoldByBusinessUnitId": null,
"ItemNumber": "Ballet PC 2018",
"OrganizationCode": null,
"CurrentLocationName": "Customer address",
"UpdateContractFlag": false,
"SourceTransactionDate": "2020-01-30T09:20:40.722+00:00",
"SoldByBusinessUnitName": null,
"CustomerName": "Computer Service and Rentals",
"CustomerNumber": "1006",
"CustomerSitePartyName": null,
"CustomerSitePartyNumber": null,
"CustomerSiteName": null,
"CustomerSiteNumber": null,
"CustomerAccountName": "Computer Service and Rentals",
"CustomerAccountNumber": "1006",
"CustomerAccountSiteName": null,
"CustomerAccountSiteNumber": null,
"CustomerAccountSiteUseCode": null,
"CustomerAssetEndDate": null,
"CustomerAssetStartDate": "2020-01-30T00:00:00+00:00",
"InServiceDate": null,
"InstalledDate": null,
"PurchaseDate": null,
"RegistrationDate": null,
"IotEnabledFlag": true,
"BOMExplosionFlag": null,
"WorkCenterId": null,
"LocationOrganizationId": null,

145 | P a g e
 Subscription Management REST Documentation

"DfltWoSubType": null,
"DfltWoType": null,
"links": [
...
]
}

Method: POST

URI: /fscmRestApi/resources/latest/customerAssets

Media Type: application/[Link]+json, application/json

Example:

[Link]

Request Body:

{
"AssetNumber": "Ballet004",
"Description": "Ballet004",
"CustomerId": 1006,
"CustomerAccountId" : 1006,
"CustomerAccountSiteUseId" : 10921,
"ItemId": 300100172651968,
"ItemOrganizationId": 204,
"Quantity": 20,
"UpdateContractFlag":"N",
"ShipmentDate": "2020-01-30"
}

Response Body:

{
"ActiveEndDate": null,
"AssetId": 300100184900124,
"AssetNumber": "Ballet004",
"CurrentLocationContext": "ORA_CUSTOMER",
"CurrentLocationId": null,
"CustomerAccountId": 1006,
"CustomerAccountSiteId": null,
"CustomerAccountSiteUseId": 10921,
"CustomerBillingPartyId": 1006,
"CustomerBillingPartySiteId": null,
"CustomerId": 1006,
"CustomerSiteId": null,
"CustomerSitePartyId": null,
"Description": "Ballet004",
"ItemId": 300100172651968,
"ItemOrganizationId": 204,
"ItemRevision": null,
"LotNumber": null,
"MaintainableFlag": true,

146 | P a g e
 Subscription Management REST Documentation

"NewWoAllowedFlag": true,
"Quantity": 20,
"SalesOrderId": null,
"SalesOrderLineId": null,
"SalesOrderLineNumber": null,
"SalesOrderNumber": null,
"SalesOrderSourceSystem": null,
"SalesOrderSourceSystemType": null,
"SerialNumber": null,
"ShipmentDate": "2020-01-30T00:00:00+00:00",
"SoldByBusinessUnitId": null,
"ItemNumber": null,
"OrganizationCode": null,
"CurrentLocationName": null,
"UpdateContractFlag": false,
"SourceTransactionDate": "2020-01-30T09:25:32.385+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-30T00: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

Media Type: application/[Link]+json, application/json

Example:

147 | P a g e
 Subscription Management REST Documentation

[Link]
ions

Request Body:

{
"TransactionType": "CUSTOMER_ASSET_SPLIT",
"TransactionDate": "2020-01-30",
"AssetId": 300100184914074,
"AssetSplitLines":[
{
"AssetId":300100184914074,
"Quantity":"80"
},
{
"AssetId":300100184900124,
"Quantity":"20"
}
]
}

148 | P a g e