/
Retrieve a future renewal...

Retrieve a future renewals report
Experimental

Request

Retrieves a future renewals report.

Security
SecretApiKey or JWT
Query
periodStartstring^\d{4}-\d{2}$

Date and time when the report starts. This date must be in the future. If no value is provided, the current month is used.

Example:periodStart=2032-01
periodEndstring^\d{4}-\d{2}$

Date and time when the report ends. This date must be in the future. If no value is provided, the current month is used.

Example:periodEnd=2032-02
limitinteger, [ 0 .. 1000 ]

Limits the number of collection items to be returned.

offsetinteger, [ 0 .. 1000 ]

Specifies the starting point within the collection of items to be returned.

curl -i -X GET \
  'https://www.rebilly.com/_mock/catalog/all/experimental/reports/future-renewals?periodStart=2032-01&periodEnd=2032-02&limit=1000&offset=1000' \
  -H 'REB-APIKEY: YOUR_API_KEY_HERE'

Responses

Report retrieved.

Headers
Pagination-Totalinteger

Total number of items.

Example:332
Pagination-Limitinteger

Maximum number of items per page.

Example:100
Pagination-Offsetinteger

Specifies the starting point within the collection of resource results. For example, a request with limit=20 retrieves and displays the first 20 results on a page. A following request with limit=20 and offset=20, retrieves the next page of 20 results.

Example:2
Bodyapplication/json
dataArray of objects

Future renewals data.

Response
{
  "data": [
    { … }
  ]
}