---
canonical_url: "https://docs.composio.dev/toolkits/baremetrics"
markdown_url: "https://docs.composio.dev/toolkits/baremetrics.md"
product: "platform"
version: null
last_updated: null
---

# Baremetrics

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

- **Category:** analytics
- **Auth:** API_KEY
- **Composio-managed OAuth available?** N/A
- **Tools:** 8
- **Triggers:** 0
- **Slug:** `BAREMETRICS`
- **Version:** 00000000_00

## Tools

### Get Account

**Slug:** `BAREMETRICS_GET_ACCOUNT`

Return the connected Baremetrics account identity, company, default currency, and calculation range.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Cohorts

**Slug:** `BAREMETRICS_GET_COHORTS`

Return Baremetrics cohort analysis for comparing customer retention and revenue behavior across signup cohorts.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `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") | Yes | 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 | Yes | Last date to include, in YYYY-MM-DD format. The range is inclusive. |
| `breakdown` | string ("customers" | "plans") | Yes | Dimension to include within each daily metric point. |
| `start_date` | string | Yes | First date to include, in YYYY-MM-DD format. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Metric Summary

**Slug:** `BAREMETRICS_GET_METRIC_SUMMARY`

Return wide daily Baremetrics business metrics for an inclusive date range, including MRR, revenue, and customer counts in each daily row.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `end_date` | string | Yes | Last date to include, in YYYY-MM-DD format. The range is inclusive. |
| `start_date` | string | Yes | First date to include, in YYYY-MM-DD format. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Metric Trend

**Slug:** `BAREMETRICS_GET_METRIC_TREND`

Return the daily time series and prior-period comparison for one Baremetrics metric over an inclusive date range.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `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") | Yes | Baremetrics metric to analyze. Monetary values use the account currency's smallest unit where applicable. |
| `end_date` | string | Yes | Last date to include, in YYYY-MM-DD format. The range is inclusive. |
| `start_date` | string | Yes | First date to include, in YYYY-MM-DD format. |
| `compare_to_days` | integer | No | Number of days before each point to compare against. Omit to use Baremetrics' default comparison period. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `source_id` | string | Yes | Source UUID returned by BAREMETRICS_LIST_SOURCES. |
| `resource_oid` | string | Yes | Provider-facing OID of the resource, usually obtained from BAREMETRICS_LIST_RECURRING_REVENUE_RESOURCES. |
| `resource_type` | string ("customer" | "plan" | "subscription" | "charge" | "refund") | Yes | Kind of recurring-revenue resource to retrieve. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `order` | string ("asc" | "desc") | No | Sort direction. Valid only for customers and subscriptions. |
| `search` | string | No | Search customer OID, email, notes, or name, or search plan name or OID. Valid only for customers and plans. |
| `sort_by` | string ("ltv" | "created") | No | Customer sort field. Valid only for customers. |
| `per_page` | integer | No | Maximum resources to return in this page (1-200). |
| `source_id` | string | Yes | Source UUID returned by BAREMETRICS_LIST_SOURCES. |
| `next_cursor` | string | No | Continuation cursor from a previous response; omit for the first page. |
| `customer_oid` | string | No | Filter subscriptions or charges to one customer OID. |
| `end_timestamp` | integer | No | Unix timestamp upper bound for charges or refunds. |
| `resource_type` | string ("customers" | "plans" | "subscriptions" | "charges" | "refunds") | Yes | Kind of recurring-revenue resource to list. |
| `start_timestamp` | integer | No | Unix timestamp lower bound for charges or refunds. |
| `subscription_oid` | string | No | Filter charges to one subscription OID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `per_page` | integer | No | Maximum sources to return in this page (1-200). |
| `next_cursor` | string | No | Continuation cursor from a previous response; omit for the first page and pass the returned value unchanged to fetch the next page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |