Read MRR
Deprecated
Returns your site's current MRR, including plan and usage breakouts.
Authorization
BasicAuth The username is a Maxio Chargify API key. The password is x.
In: header
Query Parameters
submit a timestamp in ISO8601 format to request MRR for a historic time.
date-timesubmit the id of a subscription in order to limit results.
Response Body
application/json
curl -X GET "https://example.com/mrr.json"{ "mrr": { "amount_in_cents": 9915593, "amount_formatted": "$99,155.93", "currency": "USD", "currency_symbol": "$", "at_time": "2021-02-03T14:23:17-05:00", "breakouts": { "plan_amount_in_cents": 9913593, "plan_amount_formatted": "$99,135.93", "usage_amount_in_cents": 2000, "usage_amount_formatted": "$20.00" } }}Read Site Stats GET
Returns basic site-level stats. This API call only answers with JSON responses. An XML version is not provided. ## Stats Documentation There currently is not a complimentary matching set of documentation that compliments this endpoint. However, each Site's dashboard will reflect the summary of information provided in the Stats response. ``` https://subdomain.chargify.com/dashboard ```
List MRR Movements GET
Lists your site's MRR movements. ## Understanding MRR movements This endpoint will aid in accessing your site's [MRR Report](https://maxio.zendesk.com/hc/en-us/articles/24285894587021-MRR-Analytics) 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](https://maxio.zendesk.com/hc/en-us/articles/24285894587021-MRR-Analytics#displaying-component-based-metered-usage-in-mrr) 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