Get Available Placement Test Credits

Testing

GET

/v2/placement-tests/available-slots

Retrieve information about available placement test credits (slots) across all active subscriptions. Returns total available credits, used credits, and breakdown by subscription.

Request

Header Params

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request GET 'https://api.zapmail.ai/api/v2/placement-tests/available-slots' \
--header 'x-auth-zapmail;' \
--header 'x-workspace-key;' \
--header 'x-service-provider;'

Responses

🟢200Success

application/json

Body

Example

{
  "status": 200,
  "message": "Available credits retrieved successfully",
  "data": {
    "totalAvailableCredits": 150,
    "totalUsedCredits": 80,
    "totalMonthlyCredits": 230,
    "subscriptions": [
      {
        "subscriptionId": "sub_abc123",
        "planType": "STARTER",
        "billingCycle": "LTD",
        "monthlyCredits": 30,
        "usedCredits": 12,
        "availableCredits": 18,
        "periodStart": "2024-12-01T00:00:00.000Z",
        "periodEnd": "2025-01-01T00:00:00.000Z",
        "status": "ACTIVE"
      },
      {
        "subscriptionId": "sub_def456",
        "planType": "GROWTH",
        "billingCycle": "MONTHLY",
        "monthlyCredits": 200,
        "usedCredits": 68,
        "availableCredits": 132,
        "periodStart": "2024-12-01T00:00:00.000Z",
        "periodEnd": "2025-01-01T00:00:00.000Z",
        "status": "ACTIVE"
      }
    ],
    "nextResetDate": "2025-01-01T00:00:00.000Z"
  }
}

Modified at 2025-12-24 13:02:58

Get Eligible Mailboxes for Placement Tests

Purchase Placement Test