Plans

Your plan, balance and allowances

Current plan (card or balance-paid), period, queued period, balance, and what is used of unlock / push / export allowances.

GET/v1/account/planAPI key

Response

tiersPlanTier[]

planobject | null

balanceobject

baseTrialobject

usageobject

trialobject

Responses

200OK

401No valid API key (missing, malformed, unknown or revoked).

cURL

curl -H "x-api-key: $KEY" "https://api.pmwallets.com/v1/account/plan"

json

{
  "tiers": [
    {
      "tier": "base",
      "cents": 12,
      "daily": 12,
      "monthly": 12,
      "push": 12,
      "exports": 12,
      "rank": 12,
      "onSale": true,
      "trialDays": 12
    }
  ],
  "plan": {
    "state": "active",
    "tier": "pro",
    "source": "card",
    "periodStart": "2026-11-05T10:13:00.000Z",
    "periodEnd": "2026-11-05T10:13:00.000Z",
    "endedAt": "2026-11-05T10:13:00.000Z",
    "graceUntil": "2026-11-05T10:13:00.000Z",
    "cancelAtPeriodEnd": true,
    "renewing": true,
    "nextTier": "max",
    "queued": {
      "tier": "pro",
      "startsAt": "2026-11-05T10:13:00.000Z",
      "endsAt": "2026-11-05T10:13:00.000Z"
    },
    "failedPayment": false,
    "trialing": true
  },
  "balance": {
    "cents": 12,
    "periodDays": 12
  },
  "baseTrial": {
    "days": 12,
    "eligible": true,
    "refused": true
  },
  "usage": {
    "daily": 12,
    "dailyUsed": 12,
    "monthly": 12,
    "monthlyUsed": 12,
    "push": {
      "slots": 12,
      "used": 12
    },
    "exports": {
      "cap": 12,
      "used": 12
    },
    "lookups": {
      "cap": 12,
      "usedToday": 12
    }
  },
  "trial": {}
}