GET /experimental/reports/subscription-cancellation
Retrieves a subscription cancellation report.
Servers
- https://api-sandbox.rebilly.com/organizations/{organizationId}
- https://api.rebilly.com/organizations/{organizationId}
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
limit |
Integer | No |
Limits the number of collection items to be returned. |
filter |
String | No |
Criteria for filtering collection items.
This field requires a special format.
Use For more information, see Search filters. |
periodStart |
String | No |
Date and time when the report starts. If not specified, defaults to the first day of the current month. |
periodEnd |
String | No |
Date and time when the report ends. If not specified, defaults to the last day of the current month. |
aggregationField |
String | No |
Report aggregation field. Valid values:
Default value: "planId" |
offset |
Integer | No |
Specifies the starting point within the collection of items to be returned. |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.