Baremetrics tools
The 12 Baremetrics operations your product runs on your customer's account through Connect. All of them use the same endpoint, POST /api/tools/{tool}/execute.
- List sourcesGETLists the sources of the account: each connected payment provider, such as Stripe, and the Baremetrics API itself. The id of a source is the source_id that plans, customers and subscriptions take.
- Get metrics summaryGETReturns all the metrics of the account for each day of a date range, such as mrr, arr, arpu, ltv, active_customers, new_customers and user_churn. Money values come in cents.
- Get metricGETReturns the value of one metric for each day of a date range, each with the value of compare_to days before and the percent change. Money values come in cents, so an mrr of 6024087 is 60,240.87.
- List metric customersGETLists, for each day of a date range, the customers that make up a metric, with the MRR contribution of each one in cents and the current and previous plan. For example, the upgrades metric returns the customers who upgraded in the range.
- Get metric plan breakoutGETBreaks a metric down by plan for each day of a date range: each value comes with the plan it belongs to. Money values come in cents.
- List plansGETLists the plans of a source with name, oid, billing interval and price amounts in cents. The response has meta.pagination.has_more; pass page to read the next page.
- List customersGETLists the customers of a source with oid, email, LTV and current MRR in cents, current plans and whether they are active or canceled. The response has meta.pagination.has_more; pass page to read the next page.
- List subscriptionsGETLists the subscriptions of a source with customer, plan, quantity, discount and the start and cancellation dates as Unix timestamps. The response has meta.pagination.has_more; pass page to read the next page.
- List usersGETLists the users of the Baremetrics account with id, name, email and whether they are admins. The id is the user_id that Create annotation takes.
- List annotationsGETLists the annotations of the charts, each with id, metric, text, date, whether it shows on every chart and the user who added it. The response has meta.pagination.has_more; pass page to read the next page.
- Create annotationPOSTAdds an annotation to the charts on a date, such as a launch or a campaign, and returns it with its id. All five fields are required.
- Delete annotationDELETEDeletes an annotation from the charts. The app answers 202 with an empty body.
See Connect applied to your product.
Try it for 15 days with no card, or walk our team through your use case.
