On This Page

{#jumplink-list}  
[Markdown](/docs/cybs/en-us/recurring-billing/developer/all/rest/recurring-billing-dev/recur-bill-subscriptions/recur-bill-getting-a-subscription.md)  
Filter  
FILTER BY TAG

Retrieving a Subscription {#recur-bill-getting-a-subscription}
==============================================================

You can retrieve the details of a specific subscription. The subscription details returned in the response include:

* Subscription ID
* Subscription code
* Subscription status
* Subscription name
* Subscription Merchant Reference Number
* Customer ID
* Plan ID
* Plan code
* Plan name
* Plan description
* Plan status
* Billing period unit
* Billing period length
* Billing cycles total
* Billing cycles current
* Currency
* Billing amount
* Set-up fee
* Missed payments count: only if the subscription is in a suspended state.
* Missed payments total amount: only if the subscription is in a suspended state.

Follow these steps to retrieve a subscription:

1. In the endpoint path, include the subscription ID that you received from your list of subscriptions.
2. Send the request to one of these endpoints:  
   Production: `GET https://api.cybersource.com/rbs/v1/subscriptions/{id}`  
   Test: `GET https://apitest.cybersource.test.com/rbs/v1/subscriptions/{id}`
3. Verify that the request was successful. A 200-level HTTP response code indicates success. For information about response codes, see [Transaction Response Codes](https://developer.cybersource.com/api/reference/response-codes.md "").{#recur-bill-getting-a-subscription_d9e19}

REST Examples: Retrieving a Subscription {#recur-bill-update-a-subscription-examples}
=====================================================================================

Successful Response

```
{
    "_links": {
        "self": {
            "href": "/rbs/v1/subscriptions/6192115800926177701960",
            "method": "GET"
        },
        "update": {
            "href": "/rbs/v1/subscriptions/6192115800926177701960",
            "method": "PATCH"
        },
        "cancel": {
            "href": "/rbs/v1/subscriptions/6192115800926177701960/cancel",
            "method": "POST"
        },
        "suspend": {
            "href": "/rbs/v1/subscriptions/6192115800926177701960/suspend",
            "method": "POST"
    },
    "clientReferenceInformation":{
        "code":"ORDER123"
    },
    "id": "6192115800926177701960",
    "planInformation": {
        "code": "SITPlanCode6",
        "name": "Jan11DeployPlan1",
        "billingPeriod": {
            "length": "1",
            "unit": "W"
        },
        "billingCycles": {
            "total": "6",
            "current": "1"
        }
    },
    "subscriptionInformation": {
        "code": "AWC-45",
        "planId": "6104313186846711501956",
        "name": "Testsub1",
        "startDate": "2023-04-13T17:01:42Z",
        "status": "ACTIVE"
    },
    "paymentInformation": {
        "customer": {
            "id": "C09F227C54F94951E0533F36CF0A3D91"
        }
    },
    "orderInformation": {
        "amountDetails": {
            "currency": "USD",
            "billingAmount": "1.00",
            "setupFee": "5.00"
        },
        "billTo": {
            "firstName": "JENNY",
            "lastName": "AUTO"
        }
    }
}
```

Error Response

```
{
    "status": "NOT_FOUND",
    "reason": "INVALID_DATA",
    "details": []
}
```

RELATED TO THIS PAGE