InboxKit
  1. Billing
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
    • Show mailbox credentials
    • Get mailbox details
    • Buy mailboxes
    • Check mailbox status
    • Cancel mailboxes
    • Update mailbox
    • Update mailbox profile picture
    • Generate TOTP
    • Change username
    • Change password
    • Check mailbox availability
  • 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
    • Get subscription details
      GET
    • Change subscription plan
      POST
    • Cancel subscription
      POST
    • Get wallet details
      GET
    • Add credits to wallet
      POST
    • Update auto top-up settings
      POST
    • Get billing portal link
      GET
  1. Billing

Get wallet details

GET
https://api.inboxkit.com/v1/api/billing/wallet
Billing
Maintainer:Not configured
Retrieve wallet balance and credit information
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://api.inboxkit.com/v1/api/billing/wallet'
Response Response Example
{
    "error": false,
    "message": "Wallet Details",
    "total_credits": 1000,
    "credits_used": 250,
    "credits_remaining": 750,
    "auto_topup_enabled": true,
    "auto_topup_trigger_drops_below": 100,
    "auto_topup_add_credits": 500
}

Request

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

Responses

🟢200OK
application/json
Wallet details retrieved successfully
Body
error
boolean 
optional
Example:
false
message
string 
optional
Example:
Wallet Details
total_credits
integer 
optional
Total credits available
Example:
1000
credits_used
integer 
optional
Credits consumed
Example:
250
credits_remaining
integer 
optional
Remaining credits
Example:
750
auto_topup_enabled
boolean 
optional
Whether auto top-up is enabled
Example:
true
auto_topup_trigger_drops_below
integer  | null 
optional
Credit threshold for auto top-up
Example:
100
auto_topup_add_credits
integer  | null 
optional
Credits to add during auto top-up
Example:
500
🟠401Unauthorized
🔴500Server Error
Modified at 2025-06-17 13:00:15
Previous
Cancel subscription
Next
Add credits to wallet
Built with