Zero-setup subscription analytics and insights
Datatype | Description | Example |
---|---|---|
Datepicker | String which includes date and time | |
Map | String which includes latitude and longitude coma separated | |
List | Simple array | |
Select | String with predefined values | |
Array | Array of objects |
Get your account information
Field | Type | Description |
---|---|---|
apiKey | credentials | Api key provided by Baremetrics |
Get your sources information
Field | Type | Description |
---|---|---|
apiKey | credentials | Api key provided by Baremetrics |
perPage | Number | Number of results per page |
page | Number | Number of results page |
Get your plans information
Field | Type | Description |
---|---|---|
apiKey | credentials | Api key provided by Baremetrics |
sourceId | String | ID of the source |
perPage | Number | Number of results per page |
page | Number | Number of results page |
Create new plan
Field | Type | Description |
---|---|---|
apiKey | credentials | Api key provided by Baremetrics |
sourceId | String | id of the source |
planId | String | Your unique ID for the plan |
name | String | Your internal name for this plan. This will be displayed in the Plan Breakout section |
currency | String | The ISO code of the currency of this plan. E.G: usd |
amount | Number | How much is this plan? (In cents) |
interval | Select | Interval of the plan |
intervalCount | Number | Count of the interval |
Show single plan information
Field | Type | Description |
---|---|---|
apiKey | credentials | Api key provided by Baremetrics |
sourceId | String | ID of the source |
planId | String | Your unique ID for the plan |
Delete single plan
Field | Type | Description |
---|---|---|
apiKey | credentials | Api key provided by Baremetrics |
sourceId | String | ID of the source |
planId | String | Your unique ID for the plan |
Update existing plan
Field | Type | Description |
---|---|---|
apiKey | credentials | Api key provided by Baremetrics |
sourceId | String | id of the source |
planId | String | Your unique ID for the plan |
name | String | Your internal name for this plan. This will be displayed in the Plan Breakout section |
Get your customers information
Field | Type | Description |
---|---|---|
apiKey | credentials | Api key provided by Baremetrics |
sourceId | String | ID of the source |
perPage | Number | Number of results per page |
page | Number | Number of results page |
Create new customer
Field | Type | Description |
---|---|---|
apiKey | credentials | Api key provided by Baremetrics |
sourceId | String | ID of the source |
customerId | String | Your unique ID for the customer |
String | Customer email | |
name | String | Customer name |
notes | String | Your own notes for this customer. These will be displayed in the profile |
created | DatePicker | Y-m-d hh:mm:ss of when this customer was created. Defaults to now. |
Update existing customer
Field | Type | Description |
---|---|---|
apiKey | credentials | Api key provided by Baremetrics |
sourceId | String | ID of the source |
customerId | String | Your unique ID for the customer |
String | Customer email | |
name | String | Customer name |
name | String | Your own notes for this customer. These will be displayed in the profile |
created | DatePicker | Y-m-d hh:mm:ss of when this customer was created. Defaults to now. |
Get existing customer
Field | Type | Description |
---|---|---|
apiKey | credentials | Api key provided by Baremetrics |
sourceId | String | ID of the source |
customerId | String | Your unique ID for the customer |
Get existing customer events
Field | Type | Description |
---|---|---|
apiKey | credentials | Api key provided by Baremetrics |
sourceId | String | ID of the source |
customerId | String | Your unique ID for the customer |
perPage | Number | Number of results per page |
page | Number | Number of results page |
Delete existing customer
Field | Type | Description |
---|---|---|
apiKey | credentials | Api key provided by Baremetrics |
sourceId | String | ID of the source |
customerId | String | Your unique ID for the customer |
Get your subscriptions information
Field | Type | Description |
---|---|---|
apiKey | credentials | Api key provided by Baremetrics |
sourceId | String | ID of the source |
perPage | Number | Number of results per page |
page | Number | Number of results page |
Create new subscription
Field | Type | Description |
---|---|---|
apiKey | credentials | Api key provided by Baremetrics |
sourceId | String | ID of the source |
subscriptionId | String | ID of the subscription |
startedAt | DatePicker | Date time of when this subscription started |
canceledAt | DatePicker | Date time of when this subscription was, or should be canceled. This cannot be changed, so only set this if you are certain you know when the subscription will end. |
planId | String | ID of the plan |
customerId | String | ID of the customer |
addons | List | Array of addons for this subscription |
quantity | Number | Quantity of the subscription |
discount | Number | Discount value (in the same currency as the plan) |
Get existing subscription
Field | Type | Description |
---|---|---|
apiKey | credentials | Api key provided by Baremetrics |
sourceId | String | ID of the source |
subscriptionId | String | ID of the subscription |
Update existing subscription
Field | Type | Description |
---|---|---|
apiKey | credentials | Api key provided by Baremetrics |
sourceId | String | ID of the source |
subscriptionId | String | ID of the subscription |
occurredAt | DatePicker | Date time of when this change occurred. Defaults to now |
planId | String | ID of the plan |
addons | List | Array of addons for this subscription |
quantity | Number | Quantity of the subscription |
discount | Number | Discount value (in the same currency as the plan) |
Cancel existing subscription
Field | Type | Description |
---|---|---|
apiKey | credentials | Api key provided by Baremetrics |
sourceId | String | ID of the source |
subscriptionId | String | ID of the subscription |
canceledAt | DatePicker | Date time of when this subscription was, or should be canceled. |
Delete existing subscription
Field | Type | Description |
---|---|---|
apiKey | credentials | Api key provided by Baremetrics |
sourceId | String | ID of the source |
subscriptionId | String | ID of the subscription |
Get your annotations information
Field | Type | Description |
---|---|---|
apiKey | credentials | Api key provided by Baremetrics |
perPage | Number | Number of results per page |
page | Number | Number of results page |
Create new annotations
Field | Type | Description |
---|---|---|
apiKey | credentials | Api key provided by Baremetrics |
metric | String | Which metric is this for? |
annotation | String | The annotation text |
date | DatePicker | The annotation date |
global | Boolean | Should this show on all graphs? |
userId | String | Who added this annotation? |
Show single annotation information
Field | Type | Description |
---|---|---|
apiKey | credentials | Api key provided by Baremetrics |
annotationId | String | Id of the annotations |
Delete single annotation
Field | Type | Description |
---|---|---|
apiKey | credentials | Api key provided by Baremetrics |
annotationId | String | Id of the annotations |
Get your goals information
Field | Type | Description |
---|---|---|
apiKey | credentials | Api key provided by Baremetrics |
perPage | Number | Number of results per page |
page | Number | Number of results page |
Create new goal
Field | Type | Description |
---|---|---|
apiKey | credentials | Api key provided by Baremetrics |
metric | String | Metric of the goal |
startAmount | Number | Start amount in cents |
endAmount | Number | End amount in cents |
startDate | DatePicker | Start date of goal |
endDate | DatePicker | End date of goal |
name | String | Name of goal |
Get existing goal
Field | Type | Description |
---|---|---|
apiKey | credentials | Api key provided by Baremetrics |
goalId | String | ID of the goal |
Delete existing goal
Field | Type | Description |
---|---|---|
apiKey | credentials | Api key provided by Baremetrics |
goalId | String | ID of the goal |
Get your users information
Field | Type | Description |
---|---|---|
apiKey | credentials | Api key provided by Baremetrics |
perPage | Number | Number of results per page |
page | Number | Number of results page |
Get existing user
Field | Type | Description |
---|---|---|
apiKey | credentials | Api key provided by Baremetrics |
userId | String | ID of the user |
Get your charges information
Field | Type | Description |
---|---|---|
apiKey | credentials | Api key provided by Baremetrics |
sourceId | String | ID of the source |
perPage | Number | Number of results per page |
page | Number | Number of results page |
Create new charge
Field | Type | Description |
---|---|---|
apiKey | credentials | Api key provided by Baremetrics |
sourceId | String | ID of the source |
chargeId | String | Unique ID of the charge |
customerId | String | ID of the customer |
currency | String | The ISO code of the currency of this plan. E.G: usd |
amount | Number | Charge amount (In cents) |
created | DatePicker | Datetime of when this was created (defaults to now) |
status | Select | The status of this charge. Defaults to paid. |
Get single charge
Field | Type | Description |
---|---|---|
apiKey | credentials | Api key provided by Baremetrics |
sourceId | String | ID of the source |
chargeId | String | ID of the charge |
Get your events information
Field | Type | Description |
---|---|---|
apiKey | credentials | Api key provided by Baremetrics |
sourceId | String | ID of the source |
perPage | Number | Number of results per page |
page | Number | Number of results page |
Get single event
Field | Type | Description |
---|---|---|
apiKey | credentials | Api key provided by Baremetrics |
sourceId | String | ID of the source |
eventId | String | ID of the event |
Get your summary metrics
Field | Type | Description |
---|---|---|
apiKey | credentials | Api key provided by Baremetrics |
startDate | DatePicker | Start date for summary |
endDate | DatePicker | End date for summary |
Get single metrics information
Field | Type | Description |
---|---|---|
apiKey | credentials | Api key provided by Baremetrics |
startDate | DatePicker | Start date for summary |
endDate | DatePicker | End date for summary |
metric | String | Id of the metric |
compareTo | Number | The number of days ago to compare results to |
Returns a list of customers that make up this metric. For example, the upgrades metric will return all customers who have upgraded within the selected range. You can also see their MRR contribution.
Field | Type | Description |
---|---|---|
apiKey | credentials | Api key provided by Baremetrics |
startDate | DatePicker | Start date for summary |
endDate | DatePicker | End date for summary |
metric | String | Id of the metric |
This allows you to break down a metric by plan, across a date range.
Field | Type | Description |
---|---|---|
apiKey | credentials | Api key provided by Baremetrics |
startDate | DatePicker | Start date for summary |
endDate | DatePicker | End date for summary |
metric | String | Id of the metric |