> ## Documentation Index
> Fetch the complete documentation index at: https://composio-preview.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Baremetrics

> Baremetrics provides subscription analytics, metrics, customer insights, and revenue data for recurring-revenue businesses.

![Baremetrics logo](https://mintcdn.com/composio-preview/6S5R4NszqpnVIZRD/images/toolkits/baremetrics.svg?fit=max\&auto=format\&n=6S5R4NszqpnVIZRD\&q=85\&s=e32ddcac74503834d0d36fbc7ea287f6)

* **Category:** analytics
* **Auth:** API\_KEY
* **Composio-managed OAuth available?** N/A
* **Tools:** 8
* **Triggers:** 0
* **Slug:** `BAREMETRICS`
* **Version:** 20261101\_00

## Tools

> [accordion] Get Account
>
> **Slug:** `BAREMETRICS_GET_ACCOUNT`
>
> Return the connected Baremetrics account identity, company, default currency, and calculation range.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Cohorts
>
> **Slug:** `BAREMETRICS_GET_COHORTS`
>
> Return Baremetrics cohort analysis for comparing customer retention and revenue behavior across signup cohorts.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Metric Breakdown
>
> **Slug:** `BAREMETRICS_GET_METRIC_BREAKDOWN`
>
> Return daily values for one Baremetrics metric broken down by contributing customers or plans over an inclusive date range.
>
> #### Input Parameters
>
> **metric** `string ("active_customers" | "active_subscriptions" | "active_trials" | "add_on_mrr" | "arpu" | "arr" | "cancellations" | "canceled_trials" | "churned_customers" | "converted_trials" | "coupons" | "downgrades" | "failed_charges" | "fees" | "ltv" | "mrr" | "mrr_growth_rate" | "net_revenue" | "net_revenue_churn" | "new_customers" | "new_subscriptions" | "new_trials" | "other_revenue" | "plan_quantities" | "quick_ratio" | "reactivations" | "refunds" | "revenue_churn" | "trial_conversion" | "trial_time_to_cancelation" | "trial_time_to_conversion" | "upgrades" | "user_churn")` *required*
>
> Baremetrics metric to break down. Customer breakdowns support active\_trials, add\_on\_mrr, cancellations, canceled\_trials, churned\_customers, converted\_trials, downgrades, new\_customers, new\_subscriptions, new\_trials, other\_revenue, plan\_quantities, reactivations, and upgrades. Plan breakdowns support the general Baremetrics metric vocabulary: every allowed value except add\_on\_mrr and canceled\_trials.
>
> **end\_date** `string` *required*
>
> Last date to include, in YYYY-MM-DD format. The range is inclusive.
>
> **breakdown** `string ("customers" | "plans")` *required*
>
> Dimension to include within each daily metric point.
>
> **start\_date** `string` *required*
>
> First date to include, in YYYY-MM-DD format.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Metric Summary
>
> **Slug:** `BAREMETRICS_GET_METRIC_SUMMARY`
>
> Return wide daily Baremetrics business metrics for an inclusive date range, potentially including MRR, revenue, and customer counts.
>
> #### Input Parameters
>
> **end\_date** `string` *required*
>
> Last date to include, in YYYY-MM-DD format. The range is inclusive.
>
> **start\_date** `string` *required*
>
> First date to include, in YYYY-MM-DD format.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Metric Trend
>
> **Slug:** `BAREMETRICS_GET_METRIC_TREND`
>
> Return the daily time series for one Baremetrics metric over an inclusive date range, with prior-period comparison data when available.
>
> #### Input Parameters
>
> **metric** `string ("active_customers" | "active_subscriptions" | "active_trials" | "arpu" | "arr" | "cancellations" | "churned_customers" | "converted_trials" | "coupons" | "downgrades" | "failed_charges" | "fees" | "ltv" | "mrr" | "mrr_growth_rate" | "net_revenue" | "net_revenue_churn" | "new_customers" | "new_subscriptions" | "new_trials" | "other_revenue" | "plan_quantities" | "quick_ratio" | "reactivations" | "refunds" | "revenue_churn" | "trial_conversion" | "trial_time_to_cancelation" | "trial_time_to_conversion" | "upgrades" | "user_churn")` *required*
>
> Baremetrics metric to analyze. Monetary values use the account currency's smallest unit where applicable.
>
> **end\_date** `string` *required*
>
> Last date to include, in YYYY-MM-DD format. The range is inclusive.
>
> **start\_date** `string` *required*
>
> First date to include, in YYYY-MM-DD format.
>
> **compare\_to\_days** `integer`
>
> Number of days before each point to compare against. Omit to use Baremetrics' default comparison period.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Recurring Revenue Resource
>
> **Slug:** `BAREMETRICS_GET_RECURRING_REVENUE_RESOURCE`
>
> Get one customer, plan, subscription, charge, or refund by its OID within a Baremetrics source.
>
> #### Input Parameters
>
> **source\_id** `string` *required*
>
> Source UUID returned by BAREMETRICS\_LIST\_SOURCES.
>
> **resource\_oid** `string` *required*
>
> Provider-facing OID of the resource, usually obtained from BAREMETRICS\_LIST\_RECURRING\_REVENUE\_RESOURCES.
>
> **resource\_type** `string ("customer" | "plan" | "subscription" | "charge" | "refund")` *required*
>
> Kind of recurring-revenue resource to retrieve.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Recurring Revenue Resources
>
> **Slug:** `BAREMETRICS_LIST_RECURRING_REVENUE_RESOURCES`
>
> List one page of customers, plans, subscriptions, charges, or refunds from a Baremetrics source, using only filters valid for the selected resource type.
>
> #### Input Parameters
>
> **order** `string ("asc" | "desc")`
>
> Sort direction. Valid only for customers and subscriptions.
>
> **search** `string`
>
> Search customer OID, email, notes, or name, or search plan name or OID. Valid only for customers and plans.
>
> **sort\_by** `string ("ltv" | "created")`
>
> Customer sort field. Valid only for customers.
>
> **per\_page** `integer`
>
> Maximum resources to return in this page (1-200).
>
> **source\_id** `string` *required*
>
> Source UUID returned by BAREMETRICS\_LIST\_SOURCES.
>
> **next\_cursor** `string`
>
> Continuation cursor from a previous response; omit for the first page.
>
> **customer\_oid** `string`
>
> Filter subscriptions or charges to one customer OID.
>
> **end\_timestamp** `integer`
>
> Unix timestamp upper bound for charges or refunds.
>
> **resource\_type** `string ("customers" | "plans" | "subscriptions" | "charges" | "refunds")` *required*
>
> Kind of recurring-revenue resource to list.
>
> **start\_timestamp** `integer`
>
> Unix timestamp lower bound for charges or refunds.
>
> **subscription\_oid** `string`
>
> Filter charges to one subscription OID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Sources
>
> **Slug:** `BAREMETRICS_LIST_SOURCES`
>
> List one page of payment and Baremetrics API sources in the connected account and return source IDs required by source-scoped resource tools; use next\_cursor to fetch later pages.
>
> #### Input Parameters
>
> **per\_page** `integer`
>
> Maximum sources to return in this page (1-200).
>
> **next\_cursor** `string`
>
> Continuation cursor from a previous response; omit for the first page and pass the returned value unchanged to fetch the next page.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not
