1. Package
Scaledmail
  • Scaledmail API Documentaion
  • Workspaces
    • Get Workspaces
      GET
    • Create Workspace
      POST
  • Pre Warm Inboxes
    • Pre Warm Inboxes
      GET
    • Buy Pre Warm Inboxes
      POST
  • Domain
    • Get Domains
      GET
    • Buy Domains
      POST
    • Search Domains
      POST
    • Suggest Domains
      POST
    • Update Domain Name
      POST
    • Update Domain Redirect
      POST
    • Get Purchased Domains
      GET
  • Package
    • Calculate Package
      POST
    • Get Packages
      GET
  • Order
    • Get Orders
      GET
    • Get Order Details
      GET
    • Cancel Order
      DELETE
    • Get Pending Forms
      GET
    • Submit Form
      POST
    • Create Order
      POST
    • Create Custom Order
      POST
  • Mailboxes
    • Get Mailboxes by Domain ID
      GET
  1. Package

Calculate Package

POST
https://server.scaledmail.com/api/v1/calculate-package
📐 Use this endpoint to calculate the domains, mailboxes, and pricing needed to hit a specific sending volume — before placing a custom order.
No subscription is created and no charge is made.
If you want to browse fixed pre-built packages instead, use the Get Packages endpoint.
→ Get Packages
Once you have your breakdown, use it to place your order with:
→ Create Custom Order

🔑 Request Body Parameters#

All parameters below must be included in the JSON body.

volume (required)#

The number of emails you want to send.
Must be greater than 0.
Interpreted as emails per day or per month depending on the period field.

period (optional)#

The time period your volume refers to.
"month" (default) — volume is emails per month
"day" — volume is emails per day

providers (required)#

An array of the email providers you want to use.
Must contain at least one value.
Supported values: "google", "outlook", "smtp"
"providers": ["google", "outlook"]

distribution (conditionally required)#

Specifies what percentage of your volume each provider should handle.
Single provider — omit this field entirely, or pass { "<provider>": 100 }. The system will default to 100% automatically.
Multiple providers — required. All listed providers must be included and percentages must sum to exactly 100.
"distribution": {
  "google": 60,
  "outlook": 40
}

tier (optional)#

Controls the sending volume tier, which affects how many mailboxes per domain are assumed.
"low" — conservative sending limits
"medium" — moderate sending limits
"max" (default) — maximum sending capacity per domain

FieldDescription
monthlyVolumeTotal emails per month
dailyVolumeTotal emails per day
providerBreakdownPer-provider domain, mailbox, and pricing details
providerBreakdown[].requiredDomainsNumber of domains needed for that provider
providerBreakdown[].requiredMailboxesNumber of mailboxes needed for that provider
providerBreakdown[].pricePerUnitPrice per unit in cents
providerBreakdown[].pricingBasisWhat the unit price is based on (e.g. "domain")
providerBreakdown[].totalPriceTotal price for that provider in cents
providerBreakdown[].percentageDistribution percentage assigned to that provider
totalDomainsTotal domains across all providers
totalMailboxesTotal mailboxes across all providers
totalPriceTotal price across all providers in cents

⚠️ Error Responses#

Volume too low — minimum 1 domain per ESP required#

{
  "error": "Volume too low - Minimum 1 domain per ESP required",
  "message": "Your requested volume is below the minimum threshold",
  "requested": {
    "volume": 10,
    "period": "month"
  },
  "minimum_required": {
    "volume": 500,
    "period": "month"
  }
}

Invalid input#

{ "error": "volume is required and must be greater than 0" }
{ "error": "providers array is required and must contain at least one provider (google, outlook, smtp)" }
{ "error": "period must be either 'day' or 'month'" }
{ "error": "tier must be one of: 'low', 'medium', 'max'" }
{ "error": "Distribution percentages must add up to 100. Current total: 90" }

Request

Authorization
Provide your bearer token in the
Authorization
header when making requests to protected resources.
Example:
Authorization: Bearer ********************
Body Params application/json

Examples

Responses

🟢200Success
application/json
Bodyapplication/json

Request Request Example
Shell
JavaScript
Java
Swift
cURL
curl --location 'https://server.scaledmail.com/api/v1/calculate-package' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
  "volume": 50000,
  "period": "month",
  "providers": ["google"],
  "tier": "max"
}'
Response Response Example
{
    "success": true,
    "data": {
        "monthlyVolume": 50000,
        "dailyVolume": 1667,
        "providerBreakdown": [
            {
                "provider": "google",
                "requiredDomains": 5,
                "requiredMailboxes": 10,
                "pricePerUnit": 9800,
                "pricingBasis": "domain",
                "totalPrice": 49000,
                "percentage": 100
            }
        ],
        "totalDomains": 5,
        "totalMailboxes": 10,
        "totalPrice": 49000
    }
}
Modified at 2026-04-28 07:55:41
Previous
Get Purchased Domains
Next
Get Packages
Built with