Zapmail
v1
  • latest
  • v1
  1. billing
Zapmail
v1
  • latest
  • v1
  • Zapmail Docs
  • users
    • Retrieve User Details
      GET
  • workspaces
    • Retrieve all workspaces
      GET
    • Create new workspace
      POST
    • Update workspace
      PUT
  • billing
    • Add Billing Details
      POST
  • 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
  • payments & wallet
    • Add balance to wallet
      POST
    • Get wallet balance
      GET
    • Enable auto recharge
      POST
  • export
    • Export mailboxes
      POST
    • Add third party account details
      POST
    • Update third party account details
      POST
  • subscriptions
    • Get all subscriptions
      GET
    • Cancel subscription
      POST
    • Upgrade existing subscription
      POST
  • domains
    • Retrieve All Domains
      GET
    • List Assignable Domains
      GET
    • Add DMARC record
      POST
    • Add Domain forwarding
      POST
    • Get Name servers to connect domain
      POST
    • Verify Name Server Propagation
      POST
    • Connect Domain with Zapmail
      POST
    • Enable email forwarding
      POST
    • Remove email forwarding
      DELETE
    • Enable catch all emails
      POST
    • Remove catch all emails
      DELETE
    • Check DNS records
      POST
    • Remove unused domains
      DELETE
    • Get available domains for registration
      POST
    • Get domains purchase payment link
      POST
  1. billing

Add Billing Details

POST
/v1/billing-details/add-or-update

Add or update Billing details#

This endpoint allows you to add or update user billing details associated with a workspace.

Endpoint#

Request Body#

NameTypeDescription
firstNamestringThe first name of the user.
lastNamestringThe last name of the user.
companystringThe company name of the user.
addressLineOnestringThe primary address line of the user.
addressLineTwostringThe secondary address line of the user (optional).
addressLineThreestringAdditional address details (optional).
citystringThe city where the user is located.
statestringThe state where the user is located.
countrystringThe country code of the user's location (ISO 3166-1 alpha-2).
postalCodestringThe postal code of the user.
phoneCcstringThe country code for the user's phone number.
phonestringThe phone number of the user.
workspaceIdstringThe unique ID of the workspace the user belongs to.

Example Request#

{
    "firstName": "Michael",
    "lastName": "Johnson",
    "company": "Tech Innovations",
    "addressLineOne": "2207 Maple Avenue, Suite 500",
    "addressLineTwo": "Building B",
    "addressLineThree": null,
    "city": "Dallas",
    "state": "Texas",
    "country": "US",
    "postalCode": "75201",
    "phoneCc": "1",
    "phone": "2149876543",
    "workspaceId": "44c5fd3a-d680-4808-8c6c-8d6c2043021b"
}

Request

Header Params
x-auth-zapmail
string 
required
Example:
{{x-auth-zapmail}}
Body Params application/json
object {0}
Example
{
  "firstName": "Michael",
  "lastName": "Johnson",
  "company": "Tech Innovations",
  "addressLineOne": "2207 Maple Avenue, Suite 500",
  "addressLineTwo": "Building B",
  "addressLineThree": null,
  "city": "Dallas",
  "state": "Texas",
  "country": "US",
  "postalCode": "75201",
  "phoneCc": "1",
  "phone": "2149876543"
}

Request 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 POST 'https://api.zapmail.ai/api/v1/billing-details/add-or-update' \
--header 'x-auth-zapmail: ' \
--header 'Content-Type: application/json' \
--data-raw '{
    "firstName": "Michael",
    "lastName": "Johnson",
    "company": "Tech Innovations",
    "addressLineOne": "2207 Maple Avenue, Suite 500",
    "addressLineTwo": "Building B",
    "addressLineThree": null,
    "city": "Dallas",
    "state": "Texas",
    "country": "US",
    "postalCode": "75201",
    "phoneCc": "1",
    "phone": "2149876543"
}'

Responses

🟢200Success
application/json
Body
object {0}
Example
{
  "status": 200,
  "message": "Billing details added successfully",
  "data": null
}
Previous
Update workspace
Next
Retrieve All Mailboxes
Built with