List MRR Movements
Deprecated
Lists your site's MRR movements.
Understanding MRR movements
This endpoint will aid in accessing your site's MRR Report data.
Whenever a subscription event occurs that causes your site's MRR to change (such as a signup or upgrade), we record an MRR movement. These records are accessible via the MRR Movements endpoint.
Each MRR Movement belongs to a subscription and contains a timestamp, category, and an amount. line_items represent the subscription's product configuration at the time of the movement.
Plan & Usage Breakouts
In the MRR Report UI, we support a setting to include or exclude usage revenue. In the MRR APIs, responses include plan and usage breakouts.
Plan includes revenue from:
- Products
- Quantity-Based Components
- On/Off Components
Usage includes revenue from:
- Metered Components
- Prepaid Usage Components
Authorization
BasicAuth The username is a Maxio Chargify API key. The password is x.
In: header
Query Parameters
(Optional) Filter results by subscription.
Result records are organized in pages. By default, the first page of results is displayed. The page parameter specifies a page number of results to fetch. You can start navigating through the pages to consume the results. You do this by passing in a page parameter. Retrieve the next page by adding ?page=2 to the query string. If there are no results to return, then an empty result set will be returned.
Use in query page=1.
1 <= value1This parameter indicates how many records to fetch in each request. Default value is 10. The maximum allowed values is 50; any per_page value over 50 will be changed to 50.
Use in query per_page=20.
value <= 5010Controls the order in which results are returned.
Use in query direction=asc.
Value in
- "asc"
- "desc"
Response Body
application/json
curl -X GET "https://example.com/mrr_movements.json"{ "mrr": { "page": 0, "per_page": 10, "total_pages": 80, "total_entries": 791, "currency": "USD", "currency_symbol": "$", "movements": [ { "timestamp": "2014-12-03T13:59:46-05:00", "amount_in_cents": 2173, "amount_formatted": "$21.73", "description": "Awesome Company signed up for Super Product ($21.73/mo)", "category": "new_business", "breakouts": { "plan_amount_in_cents": 2173, "plan_amount_formatted": "$21.73", "usage_amount_in_cents": 0, "usage_amount_formatted": "$0.00" }, "line_items": [ { "product_id": 306386, "component_id": 0, "price_point_id": 3856987, "name": "Cached Queries", "mrr": 2173, "mrr_movements": [ { "amount": 2173, "category": "new_business", "subscriber_delta": 0, "lead_delta": 0 } ], "quantity": 1, "prev_quantity": 0, "recurring": true } ], "subscription_id": 12355, "subscriber_name": "Amy Smith" } ] }}