v1

latestOpenAPI 3.0.02026-07-14198572488.4 KB
Account

Get user information

For given user get his customer information in one place

get/v1/account/me

Response

OK

successboolean

whether the request succeeded

errorsstring[]
messagesstring[] nullable

Example response

{
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "client": {
      "firstname": "Rocket",
      "lastname": "Net",
      "email": "user@rocket.net",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "roles": [
        "account_user",
        "user_admin"
      ],
      "tax_id": "1234567890"
    },
    "package": {
      "package_id": 1,
      "account_balance": 100,
      "account_type": "managed",
      "plan": "Agency Tier 6",
      "start_date": "2024-01-01",
      "next_due_date": "2024-02-01",
      "over_due_invoices": [
        {
          "id": 880088,
          "due_date": "2024-02-03",
          "total": 100
        }
      ]
    },
    "usage": {
      "visitors": 43540,
      "disk": 2696499,
      "bandwidth": 31558472,
      "sites": 10
    },
    "limits": {
      "disk": 230400,
      "bandwidth": 1536000,
      "sites": 100
    },
    "tasks": [
      {
        "id": "01d680d5-de78-4e26-a380-5f7ad2c0877f",
        "site_id": 8880000888,
        "perc": 90,
        "updated": "2024-01-01T02:00:00Z",
        "created": "2024-01-01T02:00:00Z",
        "message": "task execution timed out",
        "task_level": "site",
        "meta_data": "{\"cloned_site_id\": 1234567890, \"template_replacements\": [{\"key\": \"__CONTACT_EMAIL__\", \"value\": \"hello@rocket.net\"}]}",
        "site_info": {
          "id": 8880000888,
          "domain": "xn--wgv71a119e.idn.icann.org",
          "display_domain": "日本語.idn.icann.org"
        }
      }
    ],
    "pending_site_transfers": [
      {
        "transfer_id": "123e4567-e89b-12d3-a456-426614174000",
        "domain": "example.com",
        "requires_plan_upgrade": true,
        "transferring_user": {
          "firstname": "John",
          "lastname": "Doe"
        },
        "transfer_to_user": {
          "email": "newuser@example.com"
        },
        "transfer_type": "incoming",
        "site_id": 1234567890,
        "status": "accepted",
        "created_at": "2024-01-01T02:00:00Z",
        "updated_at": "2024-01-01T02:00:00Z"
      }
    ]
  }
}