Me

GET

https://api.playbook-api.com/v1/me

Last modified:2026-01-01 23:41:54

Returns account + plan + usage info for the provided API key.
Use this endpoint to verify your integration is authenticated and to view your current plan and rate limits.
Requires a valid api_key.

Request

Query Params

Responses

🟢200Success

application/json

Body

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET 'https://api.playbook-api.com/v1/me?api_key=YOUR_API_KEY'

Response Example

{
    "apiKey": "pbk_...3f87",
    "plan": "free",
    "planLabel": "Playbook API – FREE",
    "price": 0,
    "currency": "USD",
    "monthlyLimit": 500,
    "description": "For testing and low-volume usage.",
    "subscription": {
        "email": "user@example.com",
        "source": "free-signup",
        "startedAt": "2025-12-22T20:54:24.115Z",
        "status": "active",
        "stripeCustomerId": null,
        "stripeSubscriptionId": null
    },
    "usage": {
        "period": "2025-12",
        "used": 4,
        "limit": 500,
        "remaining": 496,
        "unlimited": false,
        "percentUsed": 0.8,
        "resetRule": {
            "type": "monthly",
            "day": 1,
            "timeUtc": "00:00",
            "timezone": "UTC"
        }
    }
}

Modified at 2026-01-01 23:41:54

Health

Teams