Zapmail
latest
  • latest
  • v1
  1. dns shield
Zapmail
latest
  • latest
  • v1
  • Zapmail Docs
  • users
    • Retrieve User Details
      GET
  • workspaces
    • Retrieve all workspaces
      GET
    • Create new workspace
      POST
    • Update workspace
      PUT
    • List all workspace members
      GET
    • Update user role
      PUT
    • Revoke User Access
      DELETE
    • Send invitiation to join workspace
      POST
    • List all invitations
      GET
    • Revoke invitation
      DELETE
  • billing
    • Add Billing Details
      POST
    • Update Billing Details
      PUT
  • mailbox
    • Retrieve All Mailboxes
      GET
    • Get Mailbox Details by ID
      GET
    • Assign New Mailboxes to Domains
      POST
    • Update mailbox
      PUT
    • Remove mailboxes on next renewal
      PUT
    • Get Authenticator code
      GET
    • Remove Mailboxes Instantly
      POST
    • Custom OAuth
      POST
    • schedule mailbox creation
      POST
    • retry creation of failed mailboxes
      PUT
  • payments & wallet
    • Add balance to wallet
    • Get wallet balance
    • Enable auto recharge
    • Purchase add on mailboxes
    • get invoices for subscription
  • export
    • Export mailboxes
    • Add third party account details
    • Update third party account details
    • Get Export Status
  • subscriptions
    • Get all subscriptions
    • Cancel subscription
    • Upgrade existing subscription
    • Purchase subscription
    • Get Mailboxes in a Subscription
  • domains
    • Retrieve All Domains
    • List Assignable Domains
    • Add DMARC record
    • Add Domain forwarding
    • Get Name servers to connect domain
    • Verify Name Server Propagation
    • Connect Domain with Zapmail
    • Enable email forwarding
    • Remove email forwarding
    • Enable catch all emails
    • Remove catch all emails
    • Check DNS records
    • Remove unused domains
    • Get available domains for registration
    • Get domains purchase payment link
    • Get domain connection requests
    • Remove domain connection requests
    • Connect Domain with Zapmail (New)
    • Add Google Client ID to Domain
    • Get availability of multiple domain names.
    • Retrieve Domain Health Score
    • Retrieve All Domains (With filters)
    • AI Domain Finder
    • Move Domains Across workspace
    • Assign Domain Tag
    • list domain tags
    • Create Domain Tags
    • Remove Domain Forwarding
  • dns
    • Get dns records
    • Add dns records
    • Update dns records
    • Delete dns records
  • High Reputation Domains
    • Get available domains
    • Purchase high reputation domains
  • prewarmed domains
    • Get prewarmed domains
    • purchase prewarmed subscription
    • Assign prewarmed mailboxes
    • Get Available Domains Count
  • placement test
    • Get subscriptions
    • Get Overall Report
    • Get placement test orders
    • Get report by cart order id
    • Get Eligible Mailboxes for Placement Tests
    • Get Available Placement Test Credits
    • Purchase Placement Test
    • Purchase plan
    • Cancel Subscription
  • dns shield
    • Get eligible domains
      GET
    • Get available slots
      GET
    • Get subscriptions
      GET
    • Get Allocated Domains for Subscription
      GET
    • Allocate Domains to DNS Shield
      POST
    • Purchase DNS Shield
      POST
    • Upgrade DNS Shield LTD Plan
      POST
    • Cancel subscription
      POST
  • global
    • Global mailbox-domain search
  • zapbox
    • List Connected Accounts
    • Fetch emails
    • get emails from a thread
    • Search emails
    • Send Email
    • Download Attachment
    • Create New Label
    • Delete Label
    • Rename Label
  • Schemas
    • domain with filter
  1. dns shield

Get subscriptions

Testing
GET
/v2/dns-shield/subscriptions
Retrieve all DNS Shield subscriptions (both Monthly and LTD) for the authenticated user. This endpoint returns comprehensive details about each subscription including status, pricing, billing cycle, slot capacity, and usage.

Request

Header Params

Request Code Samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://api.zapmail.ai/api/v2/dns-shield/subscriptions' \
--header 'x-auth-zapmail;' \
--header 'x-workspace-key;' \
--header 'x-service-provider;'

Responses

🟢200Success
application/json
Body

Example
{
  "status": 200,
  "message": "DNS Shield subscriptions retrieved",
  "data": [
    {
      "id": "sub-uuid-1",
      "subscriptionId": "ltd_pro_abc123xyz",
      "status": "ACTIVE",
      "lookupKey": "dns_shield_pro_ltd_2",
      "periodStart": "2024-01-15T00:00:00.000Z",
      "periodEnd": "2099-12-31T23:59:59.000Z",
      "createdAt": "2024-01-15T10:30:00.000Z",
      "updatedAt": "2024-02-01T14:20:00.000Z",
      "cancelledByUser": false,
      "invoiceLink": "<https://invoice.stripe.com/i/acct_xxxx/test_xxxx>",
      "paymentFailureMessage": null,
      "price": 299900,
      "billingCycle": "LTD",
      "totalSlots": "500",
      "totalUsedSlots": 350,
      "planType": "PRO"
    },
    {
      "id": "sub-uuid-2",
      "subscriptionId": "sub_1AbcDefGhiJklMnop",
      "status": "ACTIVE",
      "lookupKey": "zap_dns_shield",
      "periodStart": "2024-02-01T00:00:00.000Z",
      "periodEnd": "2024-03-01T00:00:00.000Z",
      "createdAt": "2024-02-01T08:15:00.000Z",
      "updatedAt": "2024-02-01T08:15:00.000Z",
      "cancelledByUser": false,
      "invoiceLink": "<https://invoice.stripe.com/i/acct_yyyy/test_yyyy>",
      "paymentFailureMessage": null,
      "price": 15000,
      "billingCycle": "MONTHLY",
      "totalSlots": "999999",
      "totalUsedSlots": 50,
      "planType": null
    },
    {
      "id": "sub-uuid-3",
      "subscriptionId": "ltd_starter_def456uvw",
      "status": "CANCELLED",
      "lookupKey": "dns_shield_starter_ltd",
      "periodStart": "2023-12-01T00:00:00.000Z",
      "periodEnd": "2024-01-15T00:00:00.000Z",
      "createdAt": "2023-12-01T12:00:00.000Z",
      "updatedAt": "2024-01-15T09:00:00.000Z",
      "cancelledByUser": true,
      "invoiceLink": "<https://invoice.stripe.com/i/acct_zzzz/test_zzzz>",
      "paymentFailureMessage": null,
      "price": 9900,
      "billingCycle": "LTD",
      "totalSlots": "30",
      "totalUsedSlots": 30,
      "planType": "STARTER"
    }
  ]
}
🟠401Unauthorized
🔴500Internal Server Error
Modified at 2026-01-12 09:48:32
Previous
Get available slots
Next
Get Allocated Domains for Subscription
Built with