View as Markdown
ChartMogul icon

ChartMogul ACTION

Retrieve MRR Churn Rate

Retrieves the Net MRR Churn Rate, for the specified time period. See the docs here
  • Action
  • Read only
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's ChartMogul account once, then configure and run Retrieve MRR Churn Rate from your backend or agent.

import { PipedreamClient } from "@pipedream/sdk"

const pd = new PipedreamClient({
  projectId: process.env.PIPEDREAM_PROJECT_ID!,
  clientId: process.env.PIPEDREAM_CLIENT_ID!,
  clientSecret: process.env.PIPEDREAM_CLIENT_SECRET!,
  projectEnvironment: "production",
})

const result = await pd.actions.run({
  id: "chartmogul-retrieve-mrr-churn-reate",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    chartmogul: { authProvisionId: "apn_xxxxxxx" },
    startDate: "Start Date",
    endDate: "End Date",
  },
})

console.log(result)

SCHEMA

Inputs

Pipedream supplies the connected account. Your application provides the operation-specific values below. Dynamic inputs are resolved against that user's account.

Retrieve MRR Churn Rate inputs
Property Type Description
startDate Start Date string
The start date of the required period of data. An ISO-8601 formatted date, e.g. 2015-05-12
Required
endDate End Date string
The end date of the required period of data. An ISO-8601 formatted date, e.g. 2015-05-12
Required
geo Geo string[]
An array of ISO 3166-1 Alpha-2 formatted country codes to filter the results to, e.g. US,GB,DE.
Optional
plans Plans string[]
An array of plan names (as configured in your ChartMogul account) to filter the results to. Note that the names are case-sensitive
Optional
interval Interval string
One of day, week, or month(default)
Optional

REFERENCE

Tool details

Behavior hints are published with the component in the Pipedream registry and surface as MCP tool annotations, so an agent can reason about a tool before it calls it.

Registry key
chartmogul-retrieve-mrr-churn-reate
Version
0.0.2
App
ChartMogul
Authentication
API key
Read-only
Yes
Destructive
No
Open world
Yes