Zapmail
OverviewAPI Reference
OverviewAPI Reference
  1. ZapShield
  • Domains
    • DNS
      • Get DNS Records
      • Add DNS Records
      • Check DNS Records
      • Add DNS Records to Multiple Domains
      • Update DNS Record
      • Delete DNS Record
    • Register
      • Search Available Domains
      • Buy Domains
      • Check Availability of Multiple Domains
      • Find Domains With AI
    • Connect
      • List Domain Connection Requests
      • Connect Domains
      • Get Nameservers to Connect a Domain
      • Verify Nameservers to Connect a Domain
      • Add Google Client ID to Domains
      • Remove Domain Connection Requests
    • Tag
      • List Domain Tags
      • Assign Tags to Domains
      • Create Domain Tags
      • Remove Tags from Domains
      • Delete Domain Tag
      • Update Domain Settings
    • Renewals
      • Search Domains Due for Renewal
      • Get Domain Renewal Prices
      • Renew Domains
      • Update Domain Auto-Renew
      • List Domains Due for Renewal
    • List Assignable Domains
      GET
    • Get Domain Health Score
      GET
    • Search Mailboxes and Domains
      GET
    • List Domains
      POST
    • Move Domains to Another Workspace
      POST
    • Remove Connected Domains
      DELETE
  • Mailbox
    • Get Authenticator Code
      GET
    • Get Mailbox
      GET
    • List Mailboxes
      POST
    • Provision Mailboxes
      POST
    • Update Mailboxes
      PUT
    • Schedule Mailbox Removal
      PUT
    • Retry Failed Mailboxes
      PUT
  • Export
    • List Third-Party Workspaces
    • Add Sequencer Details
    • Get Export Status
    • Update Sequencer Account Details
    • Add Google Client ID To Domain
    • Connect Third-Party Account
    • Connect Mailboxes With Custom OAuth
    • Fetch Workspaces by App
    • Export Mailboxes
    • Update Third-Party Account
    • Get Export Status
    • Export Mailboxes
  • Quick Setup
    • List Quick Setup Entries
    • Start Quick Setup
  • Pre-Warmed
    • List Pre-Warmed Domains
    • Count Pre-Warmed Domains
    • List Pre-Warmed Subscriptions
    • Assign Pre-Warmed Domains
    • Purchase Pre-Warmed Plan
  • Zapbox
    • List Zapbox Connected Accounts
    • List Zapbox Threads
    • Get Zapbox Thread Messages
    • Search Zapbox Emails
    • Send Zapbox Email
    • Apply Zapbox Email Action
    • Download Zapbox Attachment
    • Create Zapbox Label
    • Delete Zapbox Label
    • Rename Zapbox Label
  • User
    • Get Current User
  • Billing Details
    • Add Billing Details
    • Update Billing Details
  • Payments & Wallet
    • Get Wallet Balance
    • Add Wallet Balance
    • Enable or Disable Auto Recharge
    • Buy Add-On Mailboxes
    • Get Subscription Invoice URL
  • Subscriptions and Workspaces
    • List Workspace Members
    • List Workspace Invitations
    • List Workspaces
    • List Subscriptions
    • Create Workspace
    • Send Workspace Invitation
    • Cancel Subscription
    • List Subscription Mailboxes
    • Update Member Role
    • Update Workspace
    • Revoke Workspace Access
  • High Reputation Domains
    • List Aged Domains
    • Purchase Aged Domains
  • Deliverability
    • ZapShield
      • List ZapShield Subscriptions
        GET
      • List ZapShield Eligible Domains
        GET
      • List ZapShield Allocated Domains
        GET
      • Get ZapShield Available Slots
        GET
      • Cancel ZapShield Subscription
        POST
      • Purchase ZapShield
        POST
      • Upgrade ZapShield Plan
        POST
      • Allocate Domains to ZapShield
        POST
    • Deliverability Test
      • Get Deliverability Test Overall Report
      • List Deliverability Test Orders
      • Get Deliverability Test Report
      • List Deliverability Test Subscriptions
      • Get Deliverability Test Available Slots
      • List Deliverability Test Eligible Mailboxes
      • Purchase Deliverability Test
      • Generate Deliverability Test Spintax
      • Purchase Deliverability Test Plan
      • Cancel Deliverability Test Subscription
    • AI Insight
      • Get AI Insight Credits
      • Get AI Insight Analysis
      • Get Shared AI Insight Analysis
      • List AI Insight Eligible Mailboxes
      • Generate AI Insight Analysis
      • Calculate AI Insight Pricing
      • Purchase AI Insight Plan
      • Purchase AI Insight For Mailboxes
      • Email AI Insight Analysis
      • Share AI Insight Analysis
      • List AI Insight Analyses
      • Upgrade AI Insight Plan
    • Zap Care
      • List Zap Care Allocated Domains
      • Get Zap Care Available Slots
      • List Zap Care Subscriptions
      • List Zap Care Eligible Domains
      • Cancel Zap Care Subscription
      • Allocate Domains to Zap Care
      • Purchase Zap Care
  • Webhooks
    • List Webhook Event Types
    • List Webhook Endpoints
    • List Webhook Deliveries
    • Get Webhook Endpoint
    • Create Webhook Endpoint
    • Resend Webhook Delivery
    • Send Test Webhook Event
    • Update Webhook Endpoint
    • Delete Webhook Endpoint
  • Zap Sites
    • Get Zap Site
    • Create Zap Site
    • Regenerate Zap Site
    • Deploy Zap Site
    • Scan Zap Site Destination
    • Update Zap Site
  • Zapwarm
    • List mailboxes eligible for warmup
    • Get the Zapwarm quote for selected mailboxes
    • Start Zapwarm on selected mailboxes
    • Turn off Zapwarm on selected mailboxes
    • Edit Zapwarm settings
    • Get zapwarm score
  • ZapPulse
    • Get ZapPulse Overview
    • Get ZapPulse Insights
    • List ZapPulse Mailboxes
    • Get ZapPulse Mailbox Report
    • Create ZapPulse Report Share Link
  1. ZapShield

Upgrade ZapShield Plan

POST
https://api.zapmail.ai/api/v3/dns-shield/upgrade-plan
Upgrades an active lifetime (LTD) ZapShield subscription to a higher tier. Only upgrades are allowed: starter to growth or pro, growth to pro.
The amount charged is the new plan price (starter USD 299, growth USD 999, pro USD 2,999) minus the price recorded on the current subscription.
The tier change is applied after the Stripe invoice is paid. If requiresPayment is true, pay the invoice at invoiceUrl.
Pay-as-you-go (MONTHLY/ANNUAL) subscriptions cannot be upgraded here.
Charges your wallet. The key owner is charged the price difference. A Stripe invoice is created and settled from wallet credit; any amount the wallet does not cover stays due on the hosted invoice.
Related: List ZapShield Subscriptions (for subscriptionId), Purchase ZapShield.

Request

Header Params

Body Params application/json

Examples

Responses

🟢200Success
application/json
Upgrade invoice created.
Bodyapplication/json

🟠400BadRequest
🟠401Unauthorized
🟠403Forbidden
🟠404NotFound
🟠422UnprocessableEntity
🟠429TooManyRequests
🔴500ServerError
Request Request Example
Shell
JavaScript
Java
Swift
curl --location 'https://api.zapmail.ai/api/v3/dns-shield/upgrade-plan' \
--header 'x-auth-zapmail;' \
--header 'Content-Type: application/json' \
--data '{
    "subscriptionId": "dns_shield_starter_ltd_2_a1b2c3d4",
    "newPlanName": "growth"
}'
Response Response Example
200 - Invoice open
{
    "status": 200,
    "message": "Plan upgrade initiated. Please pay the invoice to complete the upgrade.",
    "data": {
        "subscriptionId": "b3f1c2a4-1d2e-4f5a-8b9c-0d1e2f3a4b5c",
        "oldLookupKey": "dns_shield_starter_ltd_2",
        "newLookupKey": "dns_shield_growth_ltd_2",
        "invoiceUrl": "https://invoice.stripe.com/i/acct_1Nx/test_YWNjdF8",
        "invoicePaid": false,
        "requiresPayment": true,
        "priceDifference": 700
    }
}
Previous
Purchase ZapShield
Next
Allocate Domains to ZapShield
Built with