> ## Documentation Index
> Fetch the complete documentation index at: https://docs.contiguity.com/llms.txt
> Use this file to discover all available pages before exploring further.
# Number Leasing
> Lease phone numbers using the Contiguity JavaScript SDK.
## 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.
```typescript theme={null}
const res = await contiguity.lease.available();
```
### Parameters
No parameters required.
### Response
Indicates if there are numbers available for leasing.
Array of available phone numbers with their details.
Request metadata including ID, timestamp, and API version.
## Get Number Details
Get detailed information about a specific phone number, including capabilities and pricing.
```typescript theme={null}
const res = await contiguity.lease.get("+1234567890");
```
### Parameters
Phone number in E.164 format. First argument.
### Response
Phone number details and formatting information.
The formatted phone number string.
Array of supported capabilities for this number (e.g., \["sms", "voice"]).
Pricing information for leasing this number.
Request metadata including ID, timestamp, and API version.
## Lease a Number
Create a lease for a phone number to use it as a sender.
```typescript theme={null}
const res = await contiguity.lease.create("+1234567890", { billing_method: "monthly" });
```
You can also lease a number with default billing:
```typescript theme={null}
const res = await contiguity.lease.create("+1234567890");
```
### Parameters
Phone number in E.164 format. First argument.
Optional. e.g. `{ billing_method: "monthly" }`.
### Response
Unique identifier for the created lease.
Current status of the lease (e.g., "active", "pending").
Billing information and configuration for the lease.
Request metadata including ID, timestamp, and API version.
## View Leased Numbers
Get a list of all numbers you currently have leased.
```typescript theme={null}
const res = await contiguity.lease.leased();
```
### Parameters
No parameters required.
### Response
Indicates if any numbers are currently leased.
Array of currently leased phone numbers with their details.
Request metadata including ID, timestamp, and API version.
## Get Lease Details
Get detailed information about a specific lease.
```typescript theme={null}
const res = await contiguity.lease.details("+1234567890");
```
### Parameters
Leased phone number in E.164. First argument.
### Response
Unique identifier for the lease.
Current status of the lease (e.g., "active", "expired", "terminated").
Billing information and current charges for the lease.
Request metadata including ID, timestamp, and API version.
## Configure a lease
Customize a leased number's failover behavior.
```typescript theme={null}
const res = await contiguity.lease.configure({
number: "+13059478667",
failover: { enabled: true, mode: "selective", numbers: ["+15551234567"] }
});
```
### Parameters
Leased phone number in E.164 format.
Failover configuration.
Whether failover is active.
`"all"` (any number can fail over) or `"selective"` (only listed numbers).
E.164 numbers allowed to fail over when mode is `"selective"`.
### Response
The configured number.
Applied failover config: enabled, mode, numbers.
Request metadata: id, timestamp, api\_version, object.
## Terminate a Lease
End a lease for a phone number when you no longer need it.
```typescript theme={null}
await contiguity.lease.terminate("+1234567890");
```
### Parameters
Leased phone number in E.164. First argument.
### Response
Unique identifier for the terminated lease.
Confirmation status of the termination (e.g., "terminated").
ISO 8601 formatted timestamp of when the lease was terminated.
Request metadata including ID, timestamp, and API version.
## Using Leased Numbers
Once you have a leased number, you can use it as the `from` parameter in your messaging:
```typescript theme={null}
// Use leased number as sender for SMS
const res = await contiguity.text.send({
to: "+1234567890",
message: "Hello from your dedicated number!",
from: "+15555555555" // your leased number
});
// Use leased number as sender for iMessage
const res = await contiguity.imessage.send({
to: "+1234567890",
message: "Hello via iMessage!",
from: "+15555555555" // your leased number
});
```
{
const script = document.createElement('script');
script.textContent = `
document.querySelectorAll('a[href*="mintlify.com"][href*="poweredBy"]').forEach(link => {
link.remove();
});
`
document.head.appendChild(script);
}}
/>