---
title: "Plan"
---

> Documentation Index
> Fetch the complete documentation index at: https://docs.ezghcloud.com/llms.txt
> Use this file to discover all available pages before exploring further.

Path: Billing API

## Fields

- `Plan.tier` (string, required)
  - one of `"p8"`, `"p20"`, `"p100"`
- `Plan.mode` (string, required) — cap: never pay more than the plan price; overage: usage past the credit is charged to the card.
  - one of `"cap"`, `"overage"`
- `Plan.status` (string, required)
  - one of `"scheduled"`, `"active"`, `"past_due"`, `"lapsed"`, `"cancelled"`
- `Plan.currentPeriod` (string, required) — The calendar month (UTC) the plan is in.
  - pattern `^[0-9]{4}-[0-9]{2}$`
- `Plan.startsPeriod` (string, required) — The month the plan started, or starts when scheduled.
  - pattern `^[0-9]{4}-[0-9]{2}$`
- `Plan.pendingTier` (one of, required) — A lower tier taking effect next month.
  - one of: `string`, `null`
- `Plan.cancelAtPeriodEnd` (boolean, required)
- `Plan.capSince` (one of, required) — The hour the cap began counting this month; null in overage mode.
  - one of: `string`, `null`
- `Plan.credit` (object, required)
  - `Plan.credit.amount` (string, required) — Credit usable this month.
    - pattern `^[0-9]+\.[0-9]{2}$`
  - `Plan.credit.used` (string, required) — Usage this month counted against it.
    - pattern `^[0-9]+\.[0-9]{2}$`
  - `Plan.credit.remaining` (string, required)
    - pattern `^[0-9]+\.[0-9]{2}$`
- `Plan.controls` (object, required)
  - `Plan.controls.blocked` (boolean, required) — New billable resources are refused.
  - `Plan.controls.stopped` (boolean, required) — Running instances were stopped.
- `Plan.updatedAt` (string, required)
  - format `date-time`


Source: https://docs.ezghcloud.com/billing-api/schemas/Plan/index.md
