On This Page

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

Retrieving a Plan {#recur-bill-getting-a-plan}
==============================================

You can retrieve the details of a specific plan using the plan ID. These plan details are returned in the response:

* Plan ID
* Plan code
* Plan name
* Description
* Status
* Billing period unit
* Billing period length
* Billing cycles total
* Currency
* Billing amount
* Set-up fee

Follow these steps to retrieve a plan:

1. In the endpoint path, include the plan ID that you received when you retrieved a list of plans.
2. Send the request to the recurring billing endpoint:  
   Production: `GET https://api.cybersource.com/rbs/v1/plans/{id}`  
   Test: `GET https://apitest.cybersource.test.com/rbs/v1/plans/{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-plan_d9e19}

REST Example: Retrieving a Plan {#reference_i4k_3sz_n4b}
========================================================

Response to a Successful Request

```
{
    "_links": {
        "self": {
            "href": "/rbs/v1/plans/6183561970436023701960",
            "method": "GET"
        },
        "update": {
            "href": "/rbs/v1/plans/6183561970436023701960",
            "method": "PATCH"
        },
        "activate": {
            "href": "/rbs/v1/plans/6183561970436023701960/activate",
            "method": "POST"
        }
    },
    "id": "6183561970436023701960",
    "planInformation": {
        "code": "1616024773",
        "status": "DRAFT",
        "name": "Plan Test",
        "description": "12123",
        "billingPeriod": {
            "length": "9999",
            "unit": "Y"
        },
        "billingCycles": {
            "total": "123"
        }
    },
    "orderInformation": {
        "amountDetails": {
            "currency": "USD",
            "billingAmount": "1.00",
            "setupFee": "0.00"
        }
    }
}
```

Error Response

```
{
  "status": "NOT_FOUND",
  "reason": "INVALID_DATA"
}
```

RELATED TO THIS PAGE