API Documentation

Gigs is the easiest way to offer wireless subscriptions for smartphones and wearables. Our API allows you to manage mobile plans for your customers with ease.

Getting started

To get started, create a new application in your developer settings, then read about how to make requests for the resources you need to access using our HTTP APIs.

Guides

Authentication

Learn how to authenticate your API requests.

Read more

Pagination

Understand how to work with paginated responses.

Read more

Error Codes

Read about the different types of errors returned by the API.

Read more

Resources

Add-ons

Learn more about how to work with Addons, which are additional services that can be added to a subscription.

Plans

Learn more about Plans, which determine the provider, subscription allowances and price for a given subscription.

Devices

Learn more about how to create and manage Devices.

SIMs

Learn more about how to list, search for and retrieve SIM cards within a given project.

Portings

Learn more about how to manage requests to port-in a phone number from another provider.

Projects

Learn more about how to manage Projects, an abstraction to organize your resources.

Subscription Add-ons

Learn more about how to manage Addons on a given subscription.

Subscriptions

Learn more about how to list, create and end subscriptions in order to manage connectivity on a provider network.

Subscription Changes

Learn more about how to manage planned changes to an existing subscription.

Usage

Learn more about how to fetch usage data for a given subscription.

User Addresses

Learn more about how to create and manage user addresses.

Users

Learn more about how to create, manage and search for users within a project.