InboxKit
  1. Account
InboxKit
  • Introduction
  • Account
    • Get account details
      GET
  • Workspaces
    • List workspaces
      GET
    • Get workspace details
      GET
    • Create workspace
      POST
    • Update workspace
      PUT
    • Delete workspace
      DELETE
    • Update workspace webhook
      POST
  • Domains
    • Search available domains
      POST
    • Check if domain is banned from registration
      GET
    • Check domain availability
      GET
    • Register domains
      POST
    • List domains
      GET
    • List assignable domains
      GET
    • Set DMARC policy
      POST
    • Remove DMARC policy
      DELETE
    • Remove domains
      POST
    • Set domain forwarding
      POST
    • Set email forwarding
      POST
    • Remove email forwarding
      DELETE
    • Set catch-all email
      POST
    • Remove catch-all email
      DELETE
    • Get nameservers for domain connection
      POST
    • Check nameservers propagation
      POST
  • Mailboxes
    • List mailboxes
      GET
    • Show mailbox credentials
      GET
    • Get mailbox details
      GET
    • Buy mailboxes
      POST
    • Check mailbox status
      POST
    • Cancel mailboxes
      POST
    • Update mailbox
      POST
    • Update mailbox profile picture
      POST
    • Generate TOTP
      GET
    • Change username
      POST
    • Change password
      POST
    • Check mailbox availability
      GET
  • DNS
    • Get DNS records
    • Add DNS records
    • Update DNS records
    • Delete DNS records
  • Sequencers
    • Export mailboxes status
    • List sequencer platforms
    • List sequencers
    • Export mailboxes
    • Add sequencer
    • Update sequencer
    • Delete sequencers
  • Billing
    • Get pricing plans
    • Get subscription details
    • Change subscription plan
    • Cancel subscription
    • Get wallet details
    • Add credits to wallet
    • Update auto top-up settings
    • Get billing portal link
  1. Account

Get account details

GET
https://api.inboxkit.com/v1/api/account
Account
Maintainer:Not configured
Retrieve detailed account information including credits, subscription, and configuration
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://api.inboxkit.com/v1/api/account'
Response Response Example
200 - Example 1
{
    "uid": "624688a7-e7e7-4e99-8560-614adec7a827",
    "team": "living fear",
    "admin_email": "[email protected]",
    "total_credits": 60200,
    "credits_used": 34880,
    "credits_remaining": 26712,
    "cost_per_google_mailbox": 3,
    "cost_per_ms_outlook_mailbox": 0,
    "current_plan": {
        "name": "Agency",
        "uid": "624688a7-e7e7-4e99-8560-614adec7a827",
        "cycle": "monthly",
        "pricing": 99,
        "renews_on": "2025-06-16T18:17:05.000Z",
        "purchased_on": "2025-06-16T18:17:05.000Z"
    },
    "auto_topup_enabled": false,
    "auto_topup_config": {
        "drops_below": 0,
        "add_balance": 0
    }
}

Request

Authorization
Provide your bearer token in the
Authorization
header when making requests to protected resources.
Example:
Authorization: Bearer ********************

Responses

🟢200OK
application/json
Account details retrieved successfully
Body
uid
string <uuid>
optional
Team unique identifier
Example:
624688a7-e7e7-4e99-8560-614adec7a827
team
string 
optional
Team name
Example:
living fear
admin_email
string <email>
optional
Admin user email address
Example:
[email protected]
total_credits
integer 
optional
Total wallet balance available
Example:
60200
credits_used
integer 
optional
Wallet balance consumed
Example:
34880
credits_remaining
integer 
optional
Remaining wallet balance available
Example:
26712
cost_per_google_mailbox
integer 
optional
Cost set per Google mailbox
Example:
3
cost_per_ms_outlook_mailbox
integer 
optional
Cost set per Microsoft Outlook mailbox
Example:
0
current_plan
object  | null 
optional
Current subscription plan details
name
string 
optional
Plan name
Example:
Agency
uid
string <uuid>
optional
Plan unique identifier
Example:
624688a7-e7e7-4e99-8560-614adec7a827
cycle
enum<string> 
optional
Billing cycle
Allowed values:
monthlyyearly
Example:
monthly
pricing
number 
optional
Plan price in USD
Example:
99
renews_on
string <date-time>
optional
Next renewal date
Example:
2025-06-16T18:17:05.000Z
purchased_on
string <date-time>
optional
Purchase date
Example:
2025-06-16T18:17:05.000Z
auto_topup_enabled
boolean 
optional
Whether automatic amount top-up is enabled
Example:
false
auto_topup_config
object 
optional
Auto top-up configuration settings
drops_below
integer 
optional
Amiunt threshold to trigger auto top-up
Example:
0
add_balance
integer 
optional
Amount to add during top-up
Example:
0
🟠401Unauthorized
🔴502Bad Gateway
Modified at 2025-06-19 05:43:18
Previous
Introduction
Next
List workspaces
Built with