Meter Configuration

Query the billing meter (Meter) configuration for a specified App. Meters define the mapping from event names to credit prices and serve as the basis for Events API charges.

GET https://api.profy.cn/v1/meters?app_uuid={app_uuid}

Authentication

This endpoint requires no authentication — it is a public API. You can call it directly from the client to retrieve Meter configurations and display feature pricing to users.

Query Parameters

string

required

The App’s UUID. Generated when the App is created, found on the App settings page.

Request Examples

import httpx

async with httpx.AsyncClient() as http:
    resp = await http.get(
        "https://api.profy.cn/v1/meters",
        params={"app_uuid": "your-app-uuid"},
    )
    meters = resp.json()["meters"]
    for m in meters:
        print(f"Event: {m['eventName']} → {m['priceCredits']} credits")

const resp = await fetch(
  "https://api.profy.cn/v1/meters?app_uuid=your-app-uuid"
);
const { meters } = await resp.json();

for (const m of meters) {
  console.log(`Event: ${m.eventName} → ${m.priceCredits} credits`);
}

curl "https://api.profy.cn/v1/meters?app_uuid=your-app-uuid"

Response

{
  "meters": [
    {
      "eventName": "image_generation",
      "priceCredits": 50,
      "description": "Per image generation"
    },
    {
      "eventName": "video_render",
      "priceCredits": 200,
      "description": "Per video render"
    },
    {
      "eventName": "export_pdf",
      "priceCredits": 10,
      "description": "Per PDF export"
    }
  ]
}

Meter Object

Field	Type	Description
`eventName`	`string`	Event name, use this value in `POST /v1/events`
`priceCredits`	`number`	Credits deducted per event
`description`	`string \| null`	Text description of the Meter

A Meter’s credit price is something you configure in Studio — it is your pricing decision, not a platform parameter, so documentation cannot supply a number. Whatever you set in Studio is the authoritative value.The platform constrains only one thing: each end user’s daily spend on your App defaults to a 500-credit cap (see Event Reporting). The higher your Meter price, the faster users reach that cap.

Use Cases

Display Pricing in Your App

Before users engage with paid features, call this endpoint to display credit pricing:

async function loadPricing(appUuid: string) {
  const resp = await fetch(
    `https://api.profy.cn/v1/meters?app_uuid=${appUuid}`
  );
  const { meters } = await resp.json();
  return new Map(meters.map((m: any) => [m.eventName, m.priceCredits]));
}

const pricing = await loadPricing("your-app-uuid");
const imagePrice = pricing.get("image_generation"); // 50

Validate Event Names Before Reporting

async def report_event(client, event_name: str, idem_key: str):
    async with httpx.AsyncClient() as http:
        resp = await http.get(
            "https://api.profy.cn/v1/meters",
            params={"app_uuid": "your-app-uuid"},
        )
        valid = {m["eventName"] for m in resp.json()["meters"]}

    if event_name not in valid:
        raise ValueError(f"Unknown event: {event_name}")

    return await client.events.report(event_name, idempotency_key=idem_key)

Relationship with the Events API

Meters API (GET)                Events API (POST)
  Query Meter config       →      Report event
  [eventName, price]              [event, idempotency_key]
                                        ↓
                                  Match Meter by eventName
                                        ↓
                                  Deduct credits per priceCredits

Configure Meters for your App in Profy Studio (event name + price)
Your App fetches the configuration via GET /v1/meters and displays pricing in the UI
When users use paid features, your App reports events via POST /v1/events
Profy deducts user credits based on the Meter configuration

Error Codes

HTTP Status Code	Description
`400`	Missing `app_uuid` query parameter

Get Started

Authentication & Keys

API Guides

SDK

Integrations

Cookbook

Reference

Meter Configuration

Authentication

Query Parameters

Request Examples

Response

Meter Object

Use Cases

Display Pricing in Your App

Validate Event Names Before Reporting

Relationship with the Events API

Error Codes

Next Steps

Report Billing Events

Build a Profy App

​Authentication

​Query Parameters

​Request Examples

​Response

​Meter Object

​Use Cases

​Display Pricing in Your App

​Validate Event Names Before Reporting

​Relationship with the Events API

​Error Codes

​Next Steps

Report Billing Events

Build a Profy App

Authentication

Query Parameters

Request Examples

Response

Meter Object

Use Cases

Display Pricing in Your App

Validate Event Names Before Reporting

Relationship with the Events API

Error Codes

Next Steps