Returns a list of Plans
Gets the Plans specified in the request.
Request
- Base URLhttps://api.digitalriver.com
- URLhttps://api.digitalriver.com/plans
- AuthHTTP bearer
Query parameters
The state associated with the Plans you want to retrieve.
The billing interval associated with the Plans you want to retrieve.
A cursor for use in pagination. The endingBefore parameter is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with xzy, your subsequent calls can include endingBefore=xzy in order to fetch the previous page of the list.
A cursor for use in pagination. The startingAfter parameter is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with xzy, your subsequent calls can include startingAfter=xzy in order to fetch the next page of the list.
A limit on the number of objects returned. Limit can range between 1 and 100, and the default is 10.
Response
200 OK
Example response
{
"hasMore": true,
"data": [
{
"stateTransitions": {
"activated": "2018-04-25T20:36:00Z",
"discontinued": "2018-04-25T20:36:00Z",
"deactivated": "2018-04-25T20:36:00Z"
},
"updatedTime:": "2021-06-02T13:15:09.7347766Z",
"liveMode": true,
"id": "4a1a1fdd-2f7b-4a4e-92d2-2e843f06e82a",
"terms": "These are the terms...",
"contractBindingDays": 365,
"interval": "month",
"intervalCount": 1,
"name": "Wireless keyboards",
"reminderOffsetDays": 7,
"billingOptimization": true,
"billingOffsetDays": 4,
"collectionPeriodDays": 10,
"state": "active",
"metadata": {
"coupon": "iOS"
}
}
]
}Changes
No recorded changes to this operation across all 1 revision of this API.