Retrieving 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

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

Follow these steps to retrieve a subscription:

In the endpoint path, include the subscription ID that you received from your list of subscriptions.

Send the request to the recurring billing endpoint:

ADDITIONAL INFORMATION

GET https://<url_prefix>/rbs/v1/subscriptions{id}

ADDITIONAL INFORMATION

Use one of these URL prefixes:

Test:

apitest.cybersource.com

Production:

api.cybersource.com

Production in India:

api.in.cybersource.com

Check the response message to make sure that the request was successful. A 200-level HTTP response code indicates success.

For information about response codes, see Transaction Response Codes.

REST Examples: Retrieving a Subscription

Response to a Successful Request

{
    "_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"
        }
    },
    "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": []
}

Retrieving a Subscription