ProfitWell

ProfitWell Metrics API

REST API for managing subscription lifecycle data, retrieving SaaS financial metrics (MRR, churn, ARPU, LTV), and accessing customer and engagement data on the ProfitWell Metrics (Paddle) platform. Authentication uses a bare private API key (no Bearer prefix) passed in the Authorization header. Trailing slashes on endpoint URLs are required.

GitHub

Documentation

📖
Documentation
https://www.paddle.com/help/profitwell-metrics/setup/get-started/profit-well-api
📖
APIReference
https://profitwellapiv2.docs.apiary.io/

Other Resources

🔗
Customers API
https://www.paddle.com/help/profitwell-metrics/export-data/customers-api/customers-api
🔗
JS Snippet Install
https://www.paddle.com/help/profitwell-metrics/setup/install-engagement/how-to-install-the-profit-well-js-snippet-for-engagement-data
🔗
APIsJSON
https://raw.githubusercontent.com/api-evangelist/profitwell/refs/heads/main/apis.yml

API entry from apis.yml

apis.yml Raw ↑ 
aid: profitwell:metrics-api
name: ProfitWell Metrics API
description: REST API for managing subscription lifecycle data, retrieving SaaS financial metrics (MRR,
  churn, ARPU, LTV), and accessing customer and engagement data on the ProfitWell Metrics (Paddle) platform.
  Authentication uses a bare private API key (no Bearer prefix) passed in the Authorization header. Trailing
  slashes on endpoint URLs are required.
humanURL: https://www.paddle.com/help/profitwell-metrics/setup/get-started/profit-well-api
baseURL: https://api.profitwell.com/v2
tags:
- Subscription Analytics
- SaaS Metrics
- Revenue
- REST
properties:
- type: Documentation
  url: https://www.paddle.com/help/profitwell-metrics/setup/get-started/profit-well-api
- type: APIReference
  url: https://profitwellapiv2.docs.apiary.io/
- type: Customers API
  url: https://www.paddle.com/help/profitwell-metrics/export-data/customers-api/customers-api
- type: JS Snippet Install
  url: https://www.paddle.com/help/profitwell-metrics/setup/install-engagement/how-to-install-the-profit-well-js-snippet-for-engagement-data