# Baremetrics Production API

> Baremetrics Production API on Apizie: 64 endpoints (Get Account, List Sources, List Plans, Create Plan, …) returned as clean JSON through one API key. Send your own provider key in the x-upstream-key header. Call it over REST at https://apizie.tech/v1/communication:baremetrics/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

- Project key: `communication:baremetrics`
- Category: Communication
- Status: byok
- Source: https://baremetrics.com
- Page: https://apizie.tech/api/communication/baremetrics
- OpenAPI: https://apizie.tech/api/communication/baremetrics/openapi.json

Baremetrics provides real-time subscription metrics for teams built with Stripe, Shopify Partners, Braintree, Recurly, Chargebee, Google Play, and App Store Connect. In addition to metrics, Baremetrics provides tools…

## Endpoints

### Get Account
`GET https://apizie.tech/v1/communication:baremetrics/account-get-details` (byok)

### List Sources
`GET https://apizie.tech/v1/communication:baremetrics/source-list-sources` (byok)

### List Plans
`GET https://apizie.tech/v1/communication:baremetrics/source-get-plans-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| search | string | no | Allows you to search based on the name or oid fields |
| source_id | string | yes | Please see [Sources](ref:sources) |

### Create Plan
`POST https://apizie.tech/v1/communication:baremetrics/source-create-plan` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| source_id | string | yes | Please see [Sources](ref:sources) |
| body | object | no | JSON request body |

### Show Plan
`GET https://apizie.tech/v1/communication:baremetrics/source-get-plan` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| oid | string | yes |  |
| source_id | string | yes | Please see [Sources](ref:sources) |

### Delete Plan
`POST https://apizie.tech/v1/communication:baremetrics/source-delete-plan` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| oid | string | yes |  |
| source_id | string | yes | Please see [Sources](ref:sources) |

### Update Plan
`POST https://apizie.tech/v1/communication:baremetrics/source-update-plan` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| plan_oid | string | yes | Your interval plan id |
| source_id | string | yes | Please see [Sources](ref:sources) |
| body | object | no | JSON request body |

### List Customers
`GET https://apizie.tech/v1/communication:baremetrics/source-get-customer-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| search | string | no | Allows you to search for a customer based on: oid, email, notes and name |
| source_id | string | yes | Please see [Sources](ref:sources) |
| sort | string | no | Allows you to sort the results. You can use ltv or created |
| order | string | no |  |

### Create Customer
`POST https://apizie.tech/v1/communication:baremetrics/source-create-customer-record` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| source_id | string | yes | Please see [Sources](ref:sources) |
| body | object | no | JSON request body |

### Show Customer
`GET https://apizie.tech/v1/communication:baremetrics/source-get-customer-details` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| oid | string | yes |  |
| source_id | string | yes | Please see [Sources](ref:sources) |

### Delete Customer
`POST https://apizie.tech/v1/communication:baremetrics/source-delete-customer` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| oid | string | yes |  |
| source_id | string | yes | Please see [Sources](ref:sources) |

### List Customer Events
`GET https://apizie.tech/v1/communication:baremetrics/source-list-customer-events` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| source_id | string | yes | Please see [Sources](ref:sources) |
| oid | string | yes |  |

### Update Customer
`POST https://apizie.tech/v1/communication:baremetrics/source-update-customer-information` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| customer_oid | string | yes | Your unique ID for the customer |
| source_id | string | yes | Please see [Sources](ref:sources) |
| body | object | no | JSON request body |

### List Subscriptions
`GET https://apizie.tech/v1/communication:baremetrics/source-get-subscriptions` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| source_id | string | yes | Please see [Sources](ref:sources) |
| customer_oid | string | no | This allows you to return subscriptions for a given customer |
| order | string | no | Allows you to order subscriptions from newest to oldest `desc` or oldest to newest `asc` |

### Create Subscription
`POST https://apizie.tech/v1/communication:baremetrics/source-create-subscription` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| source_id | string | yes | Please see [Sources](ref:sources) |
| body | object | no | JSON request body |

### Show Subscription
`GET https://apizie.tech/v1/communication:baremetrics/source-get-subscription` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| oid | string | yes |  |
| source_id | string | yes | Please see [Sources](ref:sources) |

### Delete Subscription
`POST https://apizie.tech/v1/communication:baremetrics/source-remove-subscription` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| oid | string | yes |  |
| source_id | string | yes | Please see [Sources](ref:sources) |

### Update Subscription
`POST https://apizie.tech/v1/communication:baremetrics/source-update-subscription` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| subscription_oid | string | yes | Your unique ID for the subscription |
| source_id | string | yes | Please see [Sources](ref:sources) |
| body | object | no | JSON request body |

### Cancel Subscription
`POST https://apizie.tech/v1/communication:baremetrics/source-cancel-subscription` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| subscription_oid | string | yes | Your unique ID for the subscription |
| source_id | string | yes | Please see [Sources](ref:sources) |
| body | object | no | JSON request body |

### List Annotations
`GET https://apizie.tech/v1/communication:baremetrics/annotation-list` (byok)

### Create Annotation
`POST https://apizie.tech/v1/communication:baremetrics/annotation-create-new` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### Show Annotation
`GET https://apizie.tech/v1/communication:baremetrics/annotation-get-details` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes |  |

### Delete Annotation
`POST https://apizie.tech/v1/communication:baremetrics/annotation-remove-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes |  |

### List Goals
`GET https://apizie.tech/v1/communication:baremetrics/goal-get-list` (byok)

### Create Goal
`POST https://apizie.tech/v1/communication:baremetrics/goal-create-new-goal` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### Show Goal
`GET https://apizie.tech/v1/communication:baremetrics/goal-get-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | Unique ID |

### Delete Goal
`POST https://apizie.tech/v1/communication:baremetrics/goal-remove` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes |  |

### List Users
`GET https://apizie.tech/v1/communication:baremetrics/user-list-users` (byok)

### Show User
`GET https://apizie.tech/v1/communication:baremetrics/user-get-user-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes |  |

### List Charges
`GET https://apizie.tech/v1/communication:baremetrics/source-get-charge-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| source_id | string | yes | Please see [Sources](ref:sources) |
| start | string | no |  |
| end | string | no |  |
| subscription_oid | string | no |  |
| customer_oid | string | no |  |

### Create Charge
`POST https://apizie.tech/v1/communication:baremetrics/source-create-charge-one-off` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| source_id | string | yes | Please see [Sources](ref:sources) |
| body | object | no | JSON request body |

### Show Charge
`GET https://apizie.tech/v1/communication:baremetrics/source-get-charge-details` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| source_id | string | yes | Please see [Sources](ref:sources) |
| oid | string | yes |  |

### Delete Charge
`POST https://apizie.tech/v1/communication:baremetrics/source-remove-one-off-charge` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| source_id | string | yes | Please see [Sources](ref:sources) |
| oid | string | yes |  |

### List Refunds
`GET https://apizie.tech/v1/communication:baremetrics/source-get-refunds` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| source_id | string | yes | Please see [Sources](ref:sources) |
| start | string | no |  |
| end | string | no |  |

### Create Refund
`POST https://apizie.tech/v1/communication:baremetrics/source-create-one-off-refund` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| source_id | string | yes | Please see [Sources](ref:sources) |
| body | object | no | JSON request body |

### Show Refund
`GET https://apizie.tech/v1/communication:baremetrics/source-get-refund-details` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| source_id | string | yes | Please see [Sources](ref:sources) |
| oid | string | yes |  |

### Delete Refund
`POST https://apizie.tech/v1/communication:baremetrics/source-remove-one-off-refund` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| source_id | string | yes | Please see [Sources](ref:sources) |
| oid | string | yes |  |

### List Events
`GET https://apizie.tech/v1/communication:baremetrics/source-get-events` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| source_id | string | yes | Please see [Sources](ref:sources) |
| live_stream | string | no | Set this to true to only return events that show up in the live stream |
| start | string | no |  |
| end | string | no |  |

### Show Event
`GET https://apizie.tech/v1/communication:baremetrics/source-get-event-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| source_id | string | yes | Please see [Sources](ref:sources) |
| id | string | yes |  |

### Show Summary
`GET https://apizie.tech/v1/communication:baremetrics/metric-show-summary` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| start_date | string | yes |  |
| end_date | string | yes |  |

### Show Metric
`GET https://apizie.tech/v1/communication:baremetrics/metric-show-details` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| metric | string | yes | You can see a list of available metrics [here](https://developers.baremetrics.com/reference/introduction) |
| start_date | string | yes |  |
| end_date | string | yes |  |
| compare_to | integer | no | The number of days ago to compare results to |

### Show Customers
`GET https://apizie.tech/v1/communication:baremetrics/metric-list-customers` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| start_date | string | yes |  |
| end_date | string | yes |  |
| metric | string | yes | You can see a list of available metrics [here](https://developers.baremetrics.com/reference/introduction) |

### Show Plan Breakout
`GET https://apizie.tech/v1/communication:baremetrics/metric-show-plan-breakout` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| start_date | string | yes |  |
| end_date | string | yes |  |
| metric | string | yes | You can see a list of available metrics [here](https://developers.baremetrics.com/reference/introduction) |

### Show Cohorts
`GET https://apizie.tech/v1/communication:baremetrics/metric-show-cohorts` (byok)

### List Fields
`GET https://apizie.tech/v1/communication:baremetrics/segment-get-fields` (byok)

### List Segments
`GET https://apizie.tech/v1/communication:baremetrics/segment-list-segments` (byok)

### Create Segment
`POST https://apizie.tech/v1/communication:baremetrics/segment-create-request` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### Show Segment
`GET https://apizie.tech/v1/communication:baremetrics/segment-show-details` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes |  |

### Update Segment
`POST https://apizie.tech/v1/communication:baremetrics/segment-update-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes |  |
| body | object | no | JSON request body |

### Delete Segment
`POST https://apizie.tech/v1/communication:baremetrics/segment-remove-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes |  |

### Search Segment
`POST https://apizie.tech/v1/communication:baremetrics/segment-find-without-save` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| per_page | integer | no |  |
| page | integer | no |  |
| sort | string | no |  |
| order | string | no |  |
| body | object | no | JSON request body |

### Set Attributes
`POST https://apizie.tech/v1/communication:baremetrics/attribute-set-properties` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### List Attribute Fields
`GET https://apizie.tech/v1/communication:baremetrics/attribute-get-fields` (byok)

### Create Attribute Field
`POST https://apizie.tech/v1/communication:baremetrics/attribute-create-field` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### Update Attribute Field
`POST https://apizie.tech/v1/communication:baremetrics/attribute-update-field` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes |  |
| body | object | no | JSON request body |

### List Events
`GET https://apizie.tech/v1/communication:baremetrics/event-list-cancellation-insight-events` (byok)

### Create Event
`POST https://apizie.tech/v1/communication:baremetrics/event-create-insight-event` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### Show Event
`GET https://apizie.tech/v1/communication:baremetrics/event-get-event-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes |  |

### Update Event
`POST https://apizie.tech/v1/communication:baremetrics/event-update-event-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes |  |
| body | object | no | JSON request body |

### Show Reason
`GET https://apizie.tech/v1/communication:baremetrics/reason-show-details` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes |  |

### Update Reason
`POST https://apizie.tech/v1/communication:baremetrics/reason-update-reason-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes |  |
| body | object | no | JSON request body |

### Delete Reason
`POST https://apizie.tech/v1/communication:baremetrics/reason-delete-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes |  |

### List Reasons
`GET https://apizie.tech/v1/communication:baremetrics/reason-list-reasons` (byok)

### Create Reason
`POST https://apizie.tech/v1/communication:baremetrics/cancellation-insight-create-new-reason` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

## Example
```
curl "https://apizie.tech/v1/communication:baremetrics/account-get-details" \
  -H "x-api-key: $APIZIE_KEY" \
  -H "x-upstream-key: $PROVIDER_KEY"
```

## FAQ

### How do I call the Baremetrics Production API?
Create a free Apizie key, then send GET https://apizie.tech/v1/communication:baremetrics/account-get-details with the header x-api-key. Every endpoint returns { project, data, timestamp }.

### Is the Baremetrics Production API free on Apizie?
Yes. The Free plan includes 1,000 requests a month at 100 requests a minute, no credit card. Baremetrics Production itself also needs your own key from api.baremetrics.com.

### Can AI agents use the Baremetrics Production API?
Yes. Add the Apizie MCP server (https://apizie.tech/mcp) to Claude, ChatGPT, Cursor or VS Code, then ask in plain language. The agent calls run_scraper with project key communication:baremetrics.

### What is the status of the Baremetrics Production API?
Needs your own provider key (bring your own key)