Retrieves the subscription product detail based on id

get

/ccstore/v1/selfservice/subscriptionProducts/{id}

If the profile is not logged in or is anonymous then the endpoint will fail. The user should be granted required access rights based on which the this api will return the subscription product detail

Request

Supported Media Types
Path Parameters
Query Parameters
  • This controls which fields are returned in the response body. This is comma seperated values
Back to Top

Response

Supported Media Types

200 Response

Response containing the subscription product detail
Body ()
Root Schema : getSubscriptionProductDetails_Response
Type: object
Show Source
Example:
{
    "PONumber":null,
    "ProductName":"ZOSS_SubscriptionItem002_AUTO",
    "BillToAccountDescription":"Computer Service and Rentals",
    "EarlyTerminationPenalty":null,
    "BillToAccountNumber":"1006",
    "PenaltyChargeName":"Penalty Fee",
    "StartDate":"2019-01-01",
    "BillToAddress":"301 Summit Hill Drive,CHATTANOOGA, TN 37401",
    "PriceAdjustmentBasis":null,
    "BillToPartyId":"1006",
    "Currency":"USD",
    "links":[
        {
            "rel":"self",
            "href":"http://localhost:8080/ccstore/v1/selfservice/subscriptionProducts/BIQA_OTBI_SM5-PRDT-8012"
        }
    ],
    "PriceAdjustmentPercent":null,
    "Status":"ORA_ACTIVE",
    "AlignBillingFrom":null,
    "BillingFrequency":"0zG",
    "CoverageScheduleId":null,
    "BillToSiteUseId":"1025",
    "SubscriptionProductPuid":"BIQA_OTBI_SM5-PRDT-8012",
    "CreditedAmount":null,
    "PaymentTermsId":"1064",
    "PaymentTermsName":"Immediate",
    "RequestedRatePlanId":null,
    "RenewalType":"RENEW",
    "WireNumber":null,
    "BillToPartyName":"Computer Service and Rentals",
    "SalesOrderNumber":null,
    "RequestedAlignBillingDate":null,
    "PriceAdjustmentType":null,
    "EarlyTerminationFee":null,
    "PaymentMethod":null,
    "GracePeriod":null,
    "InvoicedAmount":"4600",
    "SalesProductType":"SUBSCRIPTION",
    "Description":"Subscription Item",
    "InvoicingRuleName":"Advance Invoice",
    "PrimaryPartyId":"1006",
    "BillToPartyNumber":"1006",
    "PaymentMethodName":null,
    "BalanceRegisterNumber":null,
    "EarlyTerminationPenaltyName":null,
    "SubscriptionNumber":"BIQA_OTBI_SM5",
    "TotalContractValue":"5400",
    "BillingFrequencyName":"MONTH",
    "EndDate":"2020-05-31",
    "@context":{
        "headers":{
            "ETag":"ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
        },
        "key":"BIQA_OTBI_SM5-PRDT-8012"
    },
    "StatusMeaning":"Active",
    "BillToContactName":null,
    "BillToAccountId":"1006",
    "PenaltyValue":null
}

Default Response

The error response. The following are the internal error codes thrown by this API when the request processing fails in Oracle Commerce Cloud: |Error Code|Description| |------------------|------------------| |59000|If there is a missing required property.| |59002|If request can't be processed currently.| |59003|If there is any invalid path parameter| |59004|If resource is not found| |59005|If error occurred while processing input.| |59008|If any issue occurred while triggering the fusion| |59010|If self service is not enabled|
Body ()
Root Schema : Error
Type: object
Show Source
Back to Top