Jump to Content

Help Docs API Docs Business Academy Status

v1.0

Help Docs API Docs Business Academy Status

API Reference

v1.0

All

Pages

Start typing to search…

Baremetrics API

Introduction
Authentication
oAuth
Sandbox
Pagination
Rate Limit
Quick Start Guide
Reporting Issues

Account

Get Accountget

Sources

List Sourcesget

Plans

List Plansget
Show Planget
Update Planput
Create Planpost
Delete Plandel

Customers

List Customersget
Show Customerget
List Customer Eventsget
Update Customerput
Create Customerpost
Delete Customerdel

Subscriptions

List Subscriptionsget
Show Subscriptionget
Update Subscriptionput
Cancel Subscriptionput
Create Subscriptionpost
Delete Subscriptiondel

Annotations

List Annotationsget
Show Annotationget
Create Annotationpost
Delete Annotationdel

Goals

List Goalsget
Show Goalget
Create Goalpost
Delete Goaldel

Users

List Usersget
Show Userget

Charges

List Chargesget
Show Chargeget
Create Chargepost
Delete Chargedel

Refunds

List Refundsget
Show Refundget
Create Refundpost
Delete Refunddel

Events

List Eventsget
Show Eventget

Metrics

Available Metrics
- Available Metrics for the Show Customers Endpoint
Show Summaryget
Show Metricget
Show Customersget
Show Plan Breakoutget
Show Cohortsget

Segments

List Fieldsget
List Segmentsget
Show Segmentget
Search Segmentpost
Create Segmentpost
Update Segmentput
Delete Segmentdel

Attributes

Set Attributespost
List Attribute Fieldsget
Create Attribute Fieldpost
Update Attribute Fieldput

Cancellation Insights

List Eventsget
Show Eventget
Update Eventput
Create Eventpost
Show Reasonget
List Reasonsget
Create Reasonpost
Delete Reasondel
Update Reasonput

Powered by

Authentication

Authentication to the Baremetrics API is performed using a bearer token. To use this, send the following with your request: