@maxio-com/advanced-billing-sdk
Version:
Ultimate billing and pricing flexibility for B2B SaaS. Maxio integrates directly into your product, so you can seamlessly manage your product catalog, bill customers, and collect payments.
124 lines • 6.95 kB
TypeScript
/**
* AdvancedBilling
*
* This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ).
*/
import { ApiResponse, RequestOptions } from '../core';
import { Direction } from '../models/direction';
import { ListMrrFilter } from '../models/listMrrFilter';
import { ListMRRResponse } from '../models/listMRRResponse';
import { MRRResponse } from '../models/mRRResponse';
import { SiteSummary } from '../models/siteSummary';
import { SortingDirection } from '../models/sortingDirection';
import { SubscriptionMRRResponse } from '../models/subscriptionMRRResponse';
import { BaseController } from './baseController';
export declare class InsightsController extends BaseController {
/**
* The Stats API is a very basic view of some 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
* ```
*
* @return Response from the API call
*/
readSiteStats(requestOptions?: RequestOptions): Promise<ApiResponse<SiteSummary>>;
/**
* This endpoint returns your site's current MRR, including plan and usage breakouts.
*
* @param atTime submit a timestamp in ISO8601 format to request MRR for a historic time
* @param subscriptionId submit the id of a subscription in order to limit results
* @return Response from the API call
* @deprecated
*/
readMrr(atTime?: string, subscriptionId?: number, requestOptions?: RequestOptions): Promise<ApiResponse<MRRResponse>>;
/**
* This endpoint returns 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
*
* @param subscriptionId optionally filter results by subscription
* @param page 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`.
* @param perPage This 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`.
* @param direction Controls the order in which results are returned. Use in query
* `direction=asc`.
* @return Response from the API call
* @deprecated
*/
listMrrMovements({ subscriptionId, page, perPage, direction, }: {
subscriptionId?: number;
page?: number;
perPage?: number;
direction?: SortingDirection;
}, requestOptions?: RequestOptions): Promise<ApiResponse<ListMRRResponse>>;
/**
* This endpoint returns your site's current MRR, including plan and usage breakouts split per
* subscription.
*
* @param filter Filter to use for List MRR per subscription operation
* @param atTime 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`.
* @param page 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`.
* @param perPage This 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`.
* @param direction Controls the order in which results are returned. Records are ordered by
* subscription_id in ascending order by default. Use in query
* `direction=desc`.
* @return Response from the API call
* @deprecated
*/
listMrrPerSubscription({ filter, atTime, page, perPage, direction, }: {
filter?: ListMrrFilter;
atTime?: string;
page?: number;
perPage?: number;
direction?: Direction;
}, requestOptions?: RequestOptions): Promise<ApiResponse<SubscriptionMRRResponse>>;
}
//# sourceMappingURL=insightsController.d.ts.map