Retrieving a List of Subscriptions
You can retrieve a list of subscriptions with these details for each subscription:
- 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
Use the subscription ID to retrieve, amend, activate, suspend, or cancel an individual
subscription.
Follow these steps to retrieve a list of subscriptions:
- Filter the list of subscriptions by these query string parameters:
ADDITIONAL INFORMATION
- filters: Use Lucene query syntax. Only keyword-matching andANDare supported. Example:status:"ACTIVE" AND code:"01" AND id:"21345"
- offset: Page offset number.
- limit: Number of items to be returned. Default is20and maximum is100.
- Format the endpoint as follows:
ADDITIONAL INFORMATION
GET https://<url_prefix>/rbs/v1/subscriptionsADDITIONAL 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 List of Subscriptions
Successful Response
{ "_links": { "self": { "href": "/rbs/v1/subscriptions?status=ACTIVE&limit=2", "method": "GET" }, "next": { "href": "/rbs/v1/subscriptions?status=ACTIVE&offset=2&limit=2", "method": "GET" } }, "totalCount": 29, "subscriptions": [ { "_links": { "self": { "href": "/rbs/v1/subscriptions/6192112872526176101960", "method": "GET" }, "update": { "href": "/rbs/v1/subscriptions/6192112872526176101960", "method": "PATCH" }, "cancel": { "href": "/rbs/v1/subscriptions/6192112872526176101960/cancel", "method": "POST" }, "suspend": { "href": "/rbs/v1/subscriptions/6192112872526176101960/suspend", "method": "POST" } }, "id": "6192112872526176101960", "planInformation": { "code": "34873819306413101960", "name": "RainTree Books Daily Plan", "billingPeriod": { "length": "1", "unit": "D" }, "billingCycles": { "total": "2", "current": "1" } }, "subscriptionInformation": { "code": "AWC-44", "planId": "6034873819306413101960", "name": "Test", "startDate": "2023-04-13T17:01:42Z", "status": "ACTIVE" }, "paymentInformation": { "customer": { "id": "C09F227C54F94951E0533F36CF0A3D91" } }, "orderInformation": { "amountDetails": { "currency": "USD", "billingAmount": "2.00", "setupFee": "1.00" }, "billTo": { "firstName": "JENNY", "lastName": "AUTO" } } }, { "_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" }