Skip to main content
Baremetrics logo
  • Category: analytics
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 8
  • Triggers: 0
  • Slug: BAREMETRICS
  • Version: 20261101_00

Tools

Slug: BAREMETRICS_GET_ACCOUNTReturn the connected Baremetrics account identity, company, default currency, and calculation range.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BAREMETRICS_GET_COHORTSReturn Baremetrics cohort analysis for comparing customer retention and revenue behavior across signup cohorts.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BAREMETRICS_GET_METRIC_BREAKDOWNReturn daily values for one Baremetrics metric broken down by contributing customers or plans over an inclusive date range.

Input Parameters

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BAREMETRICS_GET_METRIC_SUMMARYReturn wide daily Baremetrics business metrics for an inclusive date range, potentially including MRR, revenue, and customer counts.

Input Parameters

string
required
Last date to include, in YYYY-MM-DD format. The range is inclusive.
string
required
First date to include, in YYYY-MM-DD format.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BAREMETRICS_GET_METRIC_TRENDReturn the daily time series for one Baremetrics metric over an inclusive date range, with prior-period comparison data when available.

Input Parameters

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.
string
required
Last date to include, in YYYY-MM-DD format. The range is inclusive.
string
required
First date to include, in YYYY-MM-DD format.
integer
Number of days before each point to compare against. Omit to use Baremetrics’ default comparison period.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BAREMETRICS_GET_RECURRING_REVENUE_RESOURCEGet one customer, plan, subscription, charge, or refund by its OID within a Baremetrics source.

Input Parameters

string
required
Source UUID returned by BAREMETRICS_LIST_SOURCES.
string
required
Provider-facing OID of the resource, usually obtained from BAREMETRICS_LIST_RECURRING_REVENUE_RESOURCES.
string ("customer" | "plan" | "subscription" | "charge" | "refund")
required
Kind of recurring-revenue resource to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BAREMETRICS_LIST_RECURRING_REVENUE_RESOURCESList one page of customers, plans, subscriptions, charges, or refunds from a Baremetrics source, using only filters valid for the selected resource type.

Input Parameters

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BAREMETRICS_LIST_SOURCESList 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

integer
Maximum sources to return in this page (1-200).
string
Continuation cursor from a previous response; omit for the first page and pass the returned value unchanged to fetch the next page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not