Baremetrics

Baremetrics integration (Finance, Data). Imported from open-connector.

API key9 toolshttps://api.baremetrics.com

GET

baremetrics_list_sources

List Baremetrics sources available to the current API key.

/v1/sources

GET

baremetrics_list_customers

List customers for a Baremetrics source with optional search and ordering.

/v1/{sourceId}/customers

4 parameters

Param	Type	Required	Description
sourceId	string	required	The Baremetrics source ID from the List Sources endpoint.
search	string	optional	Search customers by Baremetrics oid, email, notes, or name.
sort	string	optional	The customer field Baremetrics should sort by.
order	string	optional	The order to return Baremetrics results in.

POST

baremetrics_create_customer

Create a customer record in a Baremetrics API source.

/v1/{sourceId}/customers

6 parameters

Param	Type	Required	Description
sourceId	string	required	The Baremetrics source ID from the List Sources endpoint.
oid	string	required	Your unique Baremetrics customer ID.
name	string	optional	The customer name.
email	string	optional	The customer's email address.
notes	string	optional	Your own notes for this customer.
created	string	optional	Unix timestamp for when the customer was created.

PUT

baremetrics_update_customer

Update basic information for a Baremetrics customer.

/v1/{sourceId}/customers/{customerOid}

6 parameters

Param	Type	Required	Description
sourceId	string	required	The Baremetrics source ID from the List Sources endpoint.
customerOid	string	required	Your unique Baremetrics customer ID.
name	string	optional	The updated customer name.
email	string	optional	The updated customer email address.
notes	string	optional	Updated notes for this customer.
created	string	optional	Unix timestamp for when the customer was created.

GET

baremetrics_list_plans

List plans for a Baremetrics source with optional search.

/v1/{sourceId}/plans

2 parameters

Param	Type	Required	Description
sourceId	string	required	The Baremetrics source ID from the List Sources endpoint.
search	string	optional	Search plans by Baremetrics name or oid.

GET

baremetrics_list_subscriptions

List subscriptions for a Baremetrics source with optional customer and ordering filters.

/v1/{sourceId}/subscriptions

3 parameters

Param	Type	Required	Description
sourceId	string	required	The Baremetrics source ID from the List Sources endpoint.
customerOid	string	optional	Your unique Baremetrics customer ID.
order	string	optional	The order to return Baremetrics results in.

POST

baremetrics_create_subscription

Create a subscription in a Baremetrics API source.

/v1/{sourceId}/subscriptions

9 parameters

Param	Type	Required	Description
sourceId	string	required	The Baremetrics source ID from the List Sources endpoint.
oid	string	required	Your unique Baremetrics subscription ID.
startedAt	string	required	Unix timestamp for when the subscription started.
canceledAt	string	optional	Unix timestamp for when the subscription was or should be canceled.
planOid	string	required	Your unique Baremetrics plan ID.
customerOid	string	required	Your unique Baremetrics customer ID.
addons	array	optional	Addons attached to this subscription.
quantity	integer	optional	The subscription quantity.
discount	integer	optional	Discount amount in the same currency as the plan.

PUT

baremetrics_update_subscription

Update plan, addon, quantity, or discount data for a Baremetrics subscription.

/v1/{sourceId}/subscriptions/{subscriptionOid}

7 parameters

Param	Type	Required	Description
sourceId	string	required	The Baremetrics source ID from the List Sources endpoint.
subscriptionOid	string	required	Your unique Baremetrics subscription ID.
planOid	string	required	Your unique Baremetrics plan ID.
occurredAt	string	optional	Unix timestamp for when this subscription change occurred.
addons	array	optional	Addons attached to this subscription.
quantity	integer	optional	The subscription quantity.
discount	integer	optional	Discount amount in the same currency as the plan.

GET

baremetrics_list_charges

List charges for a Baremetrics source with optional time and entity filters.

/v1/{sourceId}/charges

5 parameters

Param	Type	Required	Description
sourceId	string	required	The Baremetrics source ID from the List Sources endpoint.
start	string	optional	Unix timestamp for the start of the charge window.
end	string	optional	Unix timestamp for the end of the charge window.
subscriptionOid	string	optional	Your unique Baremetrics subscription ID.
customerOid	string	optional	Your unique Baremetrics customer ID.