Create plan

Requires a user JWT with the admin role.

Authorization

AdminJWT

AuthorizationBearer <token>

User JWT; backend checks the admin role. Project API keys cannot access admin endpoints.

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

max_domains?integer

Range0 <= value

max_users?integer

Range0 <= value

max_mails_per_day?integer

Range0 <= value

max_mails_per_month?integer

Range0 <= value

name*string

description?string

support_level?string

polar_product_id?string

price?number

Range0 <= value

is_active?boolean

reason?string

Audit reason; required for limit exceptions, lock/score changes, overrides, rotation and deletion.

Response Body

`application/json`

curl -X POST "https://api.hisend.app/v1/admin/plans" \  -H "Content-Type: application/json" \  -d '{    "name": "string"  }'

{
  "id": 0,
  "max_domains": 0,
  "max_users": 0,
  "max_mails_per_day": 0,
  "max_mails_per_month": 0,
  "name": "string",
  "description": "string",
  "support_level": "string",
  "polar_product_id": "string",
  "created_at": "string",
  "updated_at": "string",
  "price": 0,
  "is_active": true
}

{
  "error": "string",
  "message": "string"
}

{
  "error": "string",
  "message": "string"
}

{
  "error": "string",
  "message": "string"
}

{
  "error": "string",
  "message": "string"
}

{
  "error": "string",
  "message": "string"
}

{
  "error": "string",
  "message": "string"
}

{
  "error": "string",
  "message": "string"
}

{
  "error": "string",
  "message": "string"
}

Create plan

Authorization

Request Body

Response Body

200application/json

400application/json

401application/json

403application/json

404application/json

409application/json

500application/json

502application/json

503application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`