Billing

Billing information

Account Billing

Get current billing cycle usage

get

Get current billing cycle usage for Email Sandbox and Email Sending (Email API/SMTP).

Authorizations

HeaderAuthBearerAuth

Api-TokenstringRequired

Pass the API token in the Api-Token

Path parameters

account_idinteger · int64 · min: 1Required

Unique account ID

Example: 3229

Responses

200

Returns an object with current billing cycle usage for Sandbox and Email Sending (Email API/SMTP) if available.

application/json

401

Returns unauthorized error message. Check your credentials.

application/json

403

Returns forbidden error message. Check your permissions.

application/json

get

/api/accounts/{account_id}/billing/usage

Node.jsPHPPythonC#Java

const { MailtrapClient } = require("mailtrap");
const client = new MailtrapClient({ token: "YOUR_API_KEY", accountId: YOUR_ACCOUNT_ID });
const usage = await client.billing.getUsage();
console.log(`Sandbox sent: ${usage.testing.usage.sent_messages_count.current}/${usage.testing.usage.sent_messages_count.limit}`);

{
  "billing": {
    "cycle_start": "2024-02-15T21:11:59.624Z",
    "cycle_end": "2024-02-15T21:11:59.624Z"
  },
  "testing": {
    "plan": {
      "name": "Individual"
    },
    "usage": {
      "sent_messages_count": {
        "current": 1234,
        "limit": 5000
      },
      "forwarded_messages_count": {
        "current": 0,
        "limit": 100
      }
    }
  },
  "sending": {
    "plan": {
      "name": "Basic 10K"
    },
    "usage": {
      "sent_messages_count": {
        "current": 6789,
        "limit": 10000
      }
    }
  }
}