Develop > Application Programming Interface > Legacy APIs > Catalog API > Get subscription details

Get subscription details

Details

URI /catalog/<catalog_id>/subscription/<subscription_id>
Us Catalog API to get the catalog ID and List subscriptions in the catalog to get the subscription ID.
Method GET
Parameters

userIdentifier=<user_id>

  Required; the user ID you want to use as credentials for this API call. This user should be a consumer user who has the necessary permissions for the data you want to work with. See Get userIdentifier for the steps required to get the userIdentifier value.

scope=[base|baseplusone|subtree]

Optional; default is base. If value is base, then the object is returned. If value is baseplusone, then the object and its first level children are returned. If value is subtree, then the object and all of its descendants are returned.

detail=[required|basic|standard|template|full]

  Optional; default is full. See Values for the detail parameter. Some API calls do not support all possible values for this parameter.

restrict=[true|false]

 Optional; default is true. If the value is true, then the output fields of the REST response are restricted. By default, the following fields are not displayed: createdBy, updatedBy, createdOn, updatedOn, description, iconUrl, and categoryType. If the value is false, then the output fields are displayed.

For more information, see Values for the restrict parameter

excludedoc=[true|false]

Optional; default is true. If the value is true, then the document field is not included in the REST response. If the value is false then the document field is included in the REST repsonse.

See Values for the excludedoc parameter for more information.
Returns 200 - Ok
401 - Not authorized
404 - Not found
500 - Server exception

Examples

The following URL was sent:https://<host>:<port>/csa/rest/catalog/402895e33732af18013732b6f435006b/ subscription/90d957ea3806fa7e013807acc79000b3 ?userIdentifier=90d9652b67ss6a930135f35b327e00a0

The following XML was returned:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ServiceSubscription>
    <id>90d957ea3806fa7e013807acc79000b3</id>
    <name>MY SR</name>
    <displayName>MY SR</displayName>
    <optionModel>...</optionModel>
    <serviceInstance>...</serviceInstance>
    <serviceOffering>...</serviceOffering>
    <subscriptionStatus>...</subscriptionStatus>
    <initiatingServiceRequest>...</initiatingServiceRequest>
    <basePrice xsi:type="recurrentPricingVO">...</basePrice>
    <basePrice xsi:type="initialPricingVO">...</basePrice>
    <totalPrice xsi:type="recurrentPricingVO">...</totalPrice>
    <totalPrice xsi:type="initialPricingVO">...</totalPrice>
    <pricingModel>...</pricingModel>
    <associatedRequest>
        <id>90e396c83a4cfd80013a4d06e29702bc</id>
        <name>Test Modify subscription</name>
    </associatedRequest>
    <associatedRequest>
        <id>90e396c83a4cfd80013a4d017e740003</id>
        <name>Test2 Modify subscription</name>
    </associatedRequest> 
    ...
</ServiceSubscription>

Send Help Center feedback