> ## Documentation Index
> Fetch the complete documentation index at: https://docs.spenza.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Introduction

> What the Spenza Partner API is, who it's for, and what you can build with it.

Spenza operates the connectivity behind mobile lines — SIMs, eSIMs, data/voice/SMS plans, phone numbers, billing and the users those lines are assigned to. The **Spenza Partner API** gives you programmatic access to that same connectivity layer so you can manage it from your own systems instead of a manual admin console.

Every partner account gets one API key/secret pair and one consistent contract across the whole surface:

* A predictable `{ success, data, meta }` response envelope on every call.
* One `page` / `pageSize` pagination scheme on every list endpoint.
* One error-code taxonomy (`SIM_NOT_FOUND`, `RATE_LIMITED`, and so on) instead of ad hoc messages per endpoint.
* An optional `Idempotency-Key` header on write endpoints, so a retried call replays instead of repeating.
* One async pattern for anything that takes real-world time (provisioning an eSIM, a checkout session): the call returns a `transactionId` immediately that you poll a single status endpoint with until it resolves.

<Card title="Base URL" icon="link" horizontal>
  `https://api.spenza.com`
</Card>

## What you can build

<Columns cols={2}>
  <Card title="Fleet management" icon="sim-card">
    List and inspect the SIMs on your account, see live usage against the current billing cycle, and assign or reassign SIMs to users.
  </Card>

  <Card title="Self-serve provisioning" icon="mobile-screen">
    Purchase and activate plans, provision eSIMs (with an activation QR code), and check eligibility / port existing numbers in from another carrier.
  </Card>

  <Card title="Billing integrations" icon="file-invoice-dollar">
    Pull invoices and usage summaries into your own finance tooling, check prepaid credit balance, and create top-up checkout sessions.
  </Card>

  <Card title="Team & fleet organization" icon="users" href="/api-reference">
    Organize SIMs, devices, and users into named groups with spend limits and data quotas; manage the device catalog and who it's assigned to.
  </Card>

  <Card title="Account administration" icon="user-shield" href="/api-reference">
    Invite and manage Team Members (account admins) with role tiers, and configure account-wide notification preferences.
  </Card>

  <Card title="Voice / SMS & webhooks" icon="phone" href="/api-reference">
    Send outbound SMS from a provisioned number, and register webhooks (with payload signing) for inbound SMS/voice events.
  </Card>

  <Card title="Quickstart" icon="bolt" href="/quickstart">
    A complete, copy-ready integration flow from token to first purchase.
  </Card>
</Columns>

## How the API is organized

| Resource | What it covers |
| - | - |
| **SIMs** | Inventory, live status, usage, assignment, number renewal |
| **Subscriptions** | The plan currently attached to a SIM — list, cancel |
| **Plans & Catalog** | Browse purchasable plans and SIM products; purchase a plan (sync or async) |
| **eSIM** | Provision an eSIM (with an optional plan) and fetch its activation QR code |
| **Billing** | Invoices, PDF download, prepaid credit balance and top-up |
| **Users** | The end users on your account that SIMs/devices are assigned to |
| **Orders & Transactions** | Order history and the underlying financial transactions |
| **Numbers & Port-in** | Check port-in eligibility and bring an existing phone number in from another carrier |
| **Messaging** | Send outbound SMS from a provisioned number |
| **Webhooks** | Register endpoints to receive operator SMS/voice events, inspect and redeliver past deliveries |
| **Notifications** | In-account notifications and delivery preferences |
| **Device / SIM / User Groups** | Organize your fleet into named groups with spend/data limits |
| **Devices** | The device catalog (phones/tablets) and their assignment to users |
| **Team Members** | Admins who manage your account itself, with role tiers |
| **Async Status** | The universal poll for any operation that returns a `transactionId` |

## Where to go next

* New to the API? Start with **[Getting Started](/getting-started)** to get credentials and configure your environment.
* Want the mental model first? Read **[Core Concepts](/core-concepts)** for the envelope, pagination, and async pattern used everywhere.
* Ready to write code? Jump to the **[Quickstart](/quickstart)** for a complete, copy-ready integration flow.
* Looking for a specific endpoint? Browse the **API Reference** in the sidebar.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.