---
title: "Your plan, balance and allowances"
method: GET
path: "/v1/account/plan"
tags: ["Plans"]
---

# Your plan, balance and allowances

`GET /v1/account/plan`

## Request

- Base URL: `https://api.pmwallets.com`
- URL: `https://api.pmwallets.com/v1/account/plan`
- Auth: API key in header `x-api-key`

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

## Response `200`

OK

- PlanStatus
  - `tiers` PlanTier[]
    - `tier` 'base' | 'pro' | 'max'
    - `cents` integer: Monthly price.
    - `daily` integer: Paid-band address unlocks per UTC day.
    - `monthly` integer: Paid-band address unlocks per period.
    - `push` integer: Wallets followed without the hourly charge.
    - `exports` integer: Distinct wallets exported (full range) per period.
    - `rank` integer
    - `onSale` boolean
    - `trialDays` integer
  - `plan` object, nullable
    - `state` 'active' | 'grace'
    - `tier` string
    - `source` 'card' | 'balance'
    - `periodStart` string, nullable
    - `periodEnd` string
    - `endedAt` string
    - `graceUntil` string
    - `cancelAtPeriodEnd` boolean
    - `renewing` boolean
    - `nextTier` string, nullable
    - `queued` object, nullable
      - `tier` string
      - `startsAt` string
      - `endsAt` string
    - `failedPayment` boolean
    - `trialing` boolean
  - `balance` object
    - `cents` integer
    - `periodDays` integer
  - `baseTrial` object
    - `days` integer
    - `eligible` boolean
    - `refused` boolean
  - `usage` object
    - `daily` integer
    - `dailyUsed` integer
    - `monthly` integer
    - `monthlyUsed` integer
    - `push` object
      - `slots` integer
      - `used` integer
    - `exports` object
      - `cap` integer
      - `used` integer
    - `lookups` object
      - `cap` integer
      - `usedToday` integer
  - `trial` object

## Other responses

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

---

[API](https://skmtc.dev/pmwallets/apis/pmwallets-api.md) · [All operations](https://skmtc.dev/pmwallets/apis/pmwallets-api/llms.txt) · [OpenAPI document](https://skmtc.dev/pmwallets/apis/pmwallets-api/revisions/d5023fb40430?raw)