Skip to main content
POST
Churn Rate & Retention Calculator

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
ioPeriod
enum<string>

Period Length

Available options:
monthly,
quarterly,
annual
ioCustomersStart
number

Customers at Period Start

Required range: x >= 0
ioCustomersLost
number

Customers Lost

Required range: x >= 0
ioCustomersNew
number

New Customers (optional)

Required range: x >= 0

Response

Tool output

tool
string
required
tool_version
string
required

Output-contract version for this tool. Currently "1" for all tools.

outputs
object
required
credits_used
integer
required

Credits this call consumed, after any settlement refund. 0 when metering is disabled.

request_id
string
credits_remaining
integer | null

Credits left in the current monthly allowance, or null when metering is disabled.