List MRR per subscription
Deprecated
Lists your site's current MRR, including plan and usage breakouts split per subscription.
Authorization
BasicAuth The username is a Maxio Chargify API key. The password is x.
In: header
Query Parameters
Filter to use for List MRR per subscription operation
Submit a timestamp in ISO8601 format to request MRR for a historic time. Use in query: at_time=2022-01-10T10:00:00-05:00.
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 20. The maximum allowed values is 200; any per_page value over 200 will be changed to 200.
Use in query per_page=200.
value <= 20020Controls the order in which results are returned. Records are ordered by subscription_id in ascending order by default. Use in query direction=desc.
Value in
- "asc"
- "desc"
Response Body
application/json
application/json
curl -X GET "https://example.com/subscriptions_mrr.json"{ "subscriptions_mrr": [ { "subscription_id": 0, "mrr_amount_in_cents": 0, "breakouts": { "plan_amount_in_cents": 0, "usage_amount_in_cents": 0 } } ]}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
Validate Referral Code GET
Validates whether a referral code is valid and applicable within your site. This method is useful for validating referral codes that are entered by a customer. For more information, see [Understanding Referrals](https://docs.maxio.com/hc/en-us/articles/24286981223693-Understanding-Referrals) in the product documentation.