Create Order

⚠️ Requires a connected payment method

A subscription will be created automatically upon a successful request.

🔑 Query Parameters

`price_id` (required)

The ID of the package you want to purchase.
→ Retrieve valid price_id values from the /packages endpoint.

`provider` (required)

Specifies the source of the domains:
→ "scaledmail" — Domains purchased through ScaledMail
→ "other" — Domains from external providers like Porkbun, Namecheap, or DNSimple

📥 Request Body Parameters

All parameters below must be included in the JSON body.

`quantity` (optional)

The number of package units you want to purchase.

Default: 1

You can increase it if you need multiple units of the same package.

`domains` (required)

An array of domain objects to assign to the package.

→ Get available domains from /purchased-domains.
→ The number of domains must exactly match the domain count required by the selected package.
→ If any domain is already used or unavailable, the request will fail.

Each domain object can include:

`domain` (required)

Example: "example.com"

`redirect` (optional)

A redirect URL for the domain.

Profile Picture Options

You may include:

"profile_picture": "link1.com"

If added at the domain level, this image will be used for all aliases created under that domain.

You may also specify a different profile_picture inside each alias.

👤 Aliases Handling

You now have two ways to provide alias information:

1. Pass `first_name` and `last_name`

If you include:

"first_name": "John",
"last_name": "Doe"

→ The system will automatically generate aliases for this domain.

2. Pass an `aliases` array directly

If you already have pre-generated aliases, you can send them like this:

"aliases": [
  { 
    "first_name": "User1",
    "last_name": "Test",
    "alias": "alias1",
    "profile_picture": "link1.com"
  }
]

→ When the aliases array is provided, the system will not auto-generate aliases.
→ You are free to include custom names, aliases, and profile pictures.

`hosting` (conditionally required)

Required only when provider = "other".

Must include the relevant:

SMTP/IMAP credentials

DNS configuration

Account credentials

Any required verification details

Not required when using "scaledmail" as the provider.

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

⚠️ Requires a connected payment method#

🔑 Query Parameters#

price_id (required)#

provider (required)#

📥 Request Body Parameters#

quantity (optional)#

domains (required)#

domain (required)#

redirect (optional)#

Profile Picture Options#

👤 Aliases Handling#

1. Pass first_name and last_name#

2. Pass an aliases array directly#

hosting (conditionally required)#

Request

Responses