- JavaScript
- Python
Installing the SDK
1
Install the SDK
- Bun
- pnpm
- npm
- Yarn
2
Initialize the Client
- With API key
- From env
Managing Number Leases
Lease phone numbers to use as dedicated senders for your messages, improving deliverability and brand recognition.Check Available Numbers
View available phone numbers that can be leased for your account.Get Number Details
Get detailed information about a specific phone number, including capabilities and pricing.Lease a Number
Create a lease for a phone number to use it as a sender.View Leased Numbers
Get a list of all numbers you currently have leased.Get Lease Details
Get detailed information about a specific lease.Configure a lease
Customize a leased number’s failover behavior.Terminate a Lease
End a lease for a phone number when you no longer need it.Parameters
lease.available()
No parameters required. Returns all available numbers for leasing.lease.get(params)
string
required
The phone number to get details for, in E.164 format (e.g., “+1234567890”).
lease.create(params)
string
required
The phone number to lease, in E.164 format (e.g., “+1234567890”).
string
The billing method for the lease. Options:
"monthly" for recurring monthly charges, "service_contract" for contract-based billing.lease.leased()
No parameters required. Returns all currently leased numbers.lease.details(params)
string
required
The leased phone number to get details for, in E.164 format (e.g., “+1234567890”).
lease.configure(params)
string
required
The leased phone number to configure, in E.164 format.
object
required
Failover config:
enabled, mode ("all" or "selective"), numbers (E.164[] when selective).lease.terminate(params)
string
required
The leased phone number to terminate, in E.164 format (e.g., “+1234567890”).
Using Leased Numbers
Once you have a leased number, you can use it as thefrom parameter in your messaging: