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
- application/json
Path Parameters
-
id(required): string
ID of subscription product.
Query Parameters
-
fields: string
This controls which fields are returned in the response body. This is comma seperated values
Response
Supported Media Types
- application/json
200 Response
Response containing the subscription product detail
Root Schema : getSubscriptionProductDetails_Response
Type:
Show Source
object
-
AlignBillingFrom:
string(date)
Title:
Align Billing From
The from date of the billing alignment. -
BalanceRegisterNumber:
string
Title:
Register Number
Read Only:true
Maximum Length:255
The number of the balance register associated with the product. -
BillingFrequency:
string
Title:
Billing Frequency
Maximum Length:30
The billing frequency. -
BillingFrequencyName:
string
Title:
Billing Frequency
The name of the billing frequency. -
BillToAccountDescription:
string
A brief description of the bill-to account.
-
BillToAccountId:
integer(int64)
Title:
Billing Account
The unique identifier of the bill-to account. -
BillToAccountNumber:
string
Title:
Billing Account
Maximum Length:30
The account number of the bill-to account. -
BillToAddress:
string
Title:
Bill-to Address
The bill-to address. -
BillToContactName:
string
Title:
Bill-to Contact
The bill-to contact name of the subscription product. -
BillToPartyId:
integer(int64)
Title:
Bill-to Customer
The bill-to customer ID of the subscription product. -
BillToPartyName:
string
Title:
Bill-to Customer
Read Only:true
Maximum Length:360
The bill-to customer name of the subscription product. -
BillToPartyNumber:
string
Read Only:
true
Maximum Length:30
The bill-to customer number of the subscription product. -
BillToSiteUseId:
integer(int64)
Title:
Bill-to Site
The unique identifier of the bill-to site use. -
CoverageScheduleId:
integer(int64)
Coverage Scheduled
-
CreditedAmount:
number
Title:
Credited Amount
The amount credited to a account. -
Currency:
string
Maximum Length:
15
The currency associated with the subscription product. -
Description:
string
Title:
Product Description
A brief description of the subscription product. -
EarlyTerminationFee:
number
Title:
Early Termination Fee
Read Only:true
The early termination fee. -
EarlyTerminationPenaltyName:
string
The name of the early termination penalty.
-
EndDate:
string(date)
Title:
Product End Date
The date when the subscriptions ends. -
GracePeriod:
integer(int64)
Title:
Grace Period in Days
The grace period. -
InvoicedAmount:
number
Title:
Invoiced Amount
The amount specified in the invoice. -
InvoicingRuleName:
string
Title:
Invoicing Rule
The name of the invoicing rule. -
PaymentMethod:
string
Title:
Payment Method
Maximum Length:30
The unique identifier of the payment method. -
PaymentMethodName:
string
Title:
Payment Method Name
The name of the payment method. -
PaymentTermsId:
integer(int64)
Title:
Payment Terms
The unique identifier of the payment terms. -
PaymentTermsName:
string
Title:
Payment Terms
The name of the payment terms. -
PenaltyChargeName:
string
The penalty charge name.
-
PenaltyValue:
number
Title:
Penalty Value
The penalty value. -
PONumber:
string
Title:
PO Number
Maximum Length:50
The number of the purchase order. -
PriceAdjustmentBasis:
string
Title:
Price Adjustment Basis
Maximum Length:30
The basis on the which the price is adjusted. -
PriceAdjustmentPercent:
number
Title:
Price Adjustment Value
The price adjustment percent. -
PriceAdjustmentType:
string
Title:
Price Adjustment Type
Maximum Length:30
The type of the price adjustment. -
PrimaryPartyId:
integer(int64)
Read Only:
true
The primary party ID of the subscription product. -
ProductName:
string
Title:
Product Name
Maximum Length:300
The name of the product. -
RenewalType:
string
Title:
Product Renewal Type
Maximum Length:30
The type of subscription renewal. -
RequestedRatePlanId:
integer(int64)
The unique identifier of the requested rate plan.
-
SalesOrderNumber:
string
Title:
Sales Order Number
Maximum Length:200
The number of the sales order associated with the subscription product. -
SalesProductType:
string
Title:
Type
Maximum Length:30
The type of the sales product. -
StartDate:
string(date)
Title:
Product Start Date
The date when the subscriptions starts. -
Status:
string
Title:
Status
Maximum Length:30
Default Value:DRAFT
The status of the subscription product. -
StatusMeaning:
string
Title:
Product Status
Read Only:true
Maximum Length:80
The meaning of the product status. -
SubscriptionNumber:
string
Title:
Subscription Number
Maximum Length:120
The subscription number of the product. -
SubscriptionProductPuid:
string
Title:
Subscription Product Number
Maximum Length:120
The public unique identifier of the subscription product. -
TotalContractValue:
number
Title:
Product Contract Value
The value of the total contract. -
WireNumber:
string
Title:
Wire Number
Maximum Length:30
The wire number.
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|
Root Schema : Error
Type:
Show Source
object
-
message:
string
The error message
-
status:
string
The Error code