Retrieve Specific Subscription

The Retrieve Specific Subscription request enables you to retrieve details about one existing subscription.



You can test out a request that hits our sandbox in real-time. Follow the instructions here to use the "Try It!" feature on the right side.

Request Content

  • Enter the subscriptionId into the web service URL, in the format: services/2/recurring/subscriptions/{subscriptionId} For example: services/2/recurring/subscriptions/2111111
  • networkTransactionInfo   object   optional. You can only include the inner element 'originalNetworkTransactionId' (refer to networkTransactionInfo)

Response Details

If successful, the response HTTP status code is 200 OK. The response contains the retrieved subscription object.


Request Examples

curl -v -X GET \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \ 
-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' \
-d '

Response Examples

    "nextChargeDate": "2016-08-15",
    "quantity": 1,
    "trialPeriodDays": 14,
    "paymentSource": {"creditCardInfo": {
        "billingContactInfo": {
            "firstName": "John",
            "lastName": "Doe"
        "creditCard": {
            "expirationYear": 2023,
            "cardLastFourDigits": 1111,
            "cardSubType": "CREDIT",
            "cardCategory": "CLASSIC",
            "cardType": "VISA",
            "expirationMonth": "07"
    "softDescriptor": "Example descriptor",
    "recurringChargeAmount": 29.99,
    "chargeFrequency": "MONTHLY",
    "vaultedShopperId": 21188039,
    "payerInfo": {
        "firstName": "John",
        "lastName": "Doe"
    "initialChargeAmount": 100,
    "autoRenew": true,
    "planId": 2283845,
    "currency": "USD",
    "subscriptionId": 8491535,
    "status": "ACTIVE"

Back to Top

API Explorer

To test out a call, enter an existing subscription ID (e.g 8491535) in the subscriptionId field. This will automatically insert the ID into the request URL.

Click Try It! to start a request and see the response here!