[ Web Proxy ]
URL:
Viewing: https://gigs.com/api [Back]  [Original]

API: One telecom integration for multiple markets and carriers
Open menu

API

Build connectivity into your product

Customer Centric

Solve your customers needs

Manage the full subscription lifecycle, from number porting and connectivity to upgrades and top-ups.

Create a Plan

Manage Subscriptions

[]
[]
Versioned changes

Ensure your integration stands the test of time with thoughtful updates and versioning

Thoroughly documented

Know what to expect with carrier guides and descriptions for every endpoint

Globally scalable

Expand fast with new markets as parameters on existing abstractions

Observable

Design neat, scalable business logic with webhooks and events for every phone plan permutation

Performant

Address realtime use cases at scale with low latency and high uptime

Easy to test and troubleshoot

Build and test efficiently with custom parameters, samples and error codes

>99.99% uptime

Documentation

Explore the docs

Code examples

List plansCreate a userCreate a user addressCreate a subscriptionCreate a portingList addons

Request

curl --request GET
  --url 'https://api.gigs.com/projects/my-project/plans'
  --header 'Accept: application/json'
  --header 'Authorization: Bearer 123'

Response

{
  "object": "list",
  "items": [
    {
      "object": "plan",
      "id": "pln_0SNlurA049MEWV3V0q7gjQbM4EVo",
      "allowances": {
        "dataBytes": 10000000000,
        "voiceSeconds": 30000,
        "smsMessages": 100
      },
      "coverage": {
        "object": "coverage",
        "id": "de",
        "countries": [
          "DE",
          "FR",
          "US"
        ],
        "name": "Europe"
      },
      "data": 10000000000,
      "dataUnit": "byte",
      "description": "A data plan you will love! Operates in most countries of the world.",
      "image": "https://i.gigscdn.com/pr/nTZpgaEj5dTQ2Jo/original.png",
      "limits": {
        "dataBytes": 100000000000,
        "bandwidthBitsPerSecond": null,
        "throttling": {
          "thresholdBytes": 10000000000,
          "bandwidthBitsPerSecond": 512000
        }
      },
      "name": "Gigs Global",
      "price": {
        "amount": 999,
        "currency": "USD"
      },
      "provider": "p5",
      "requirements": {
        "address": "present",
        "device": "none",
        "user.birthday": "none",
        "user.fullName": "present"
      },
      "simTypes": [
        "eSIM",
        "pSIM"
      ],
      "sms": 100,
      "smsUnit": "message",
      "status": "available",
      "validity": {
        "minimumPeriods": 12,
        "type": "recurring",
        "unit": "day",
        "value": 7
      },
      "voice": 30000,
      "voiceUnit": "second",
      "createdAt": "2021-01-21T19:38:34Z"
    }
  ],
  "moreItemsAfter": null,
  "moreItemsBefore": null
}
Gigs Core API
Add-ons [Add-ons]
Add-ons

Top-ups and additional services

Devices [Devices]
Devices

Manage and update devices

Plans [Plans]
Plans

Your custom mobile plans

Portings [Portings]
Portings

Port-in and out phone numbers

Projects [Projects]
Projects

Manage multiple projects

SIMs [SIMs]
SIMs

View and manage SIM inventory

Subscription add-ons [Subscription add-ons]
Subscription add-ons

Add-ons attached to a subscription

Subscription changes [Subscription changes]
Subscription changes

Upgrades and downgrades

Usage [Usage]
Usage

Subscription usage data

Users [Users]
Users

Create and manage users

User Addresses [User Addresses]
User Addresses

Create and manage addresses

Gigs Billing API
Quotes [Quotes]
Quotes

Preview charges, including taxes and fees

Invoices [Invoices]
Invoices

Manage automated invoices

Credit Notes [Credit Notes]
Credit Notes

Issue credits and refunds

Customer Insights

Using Gigs API, we were able to deeply integrate and start selling custom eSIMs in our app. Gigs' documentation was very straightforward, and our engineers loved working with the telecom API. This integration allows us to meet our clients' financial and connectivity needs all from one app.

Sam Newman-Bremang, Sr. Product Director

Still unsure? Get a second opinion.

Ask ChatGPT, Claude, or Perplexity how the Gigs API stacks up.

Speak to a member of our team.

There's no need to be an expert to work with Gigs - we'll help you through every step of the process. Fill out the contact form below and we'll be in touch soon.

Gigs Connect

Your plug-and-play hosted checkout for mobile plans. Customers sign up, pay, activate their SIM and manage their plan via Gigs Connect.

Explore Connect
Gigs for Work

Simplify global phone plan management. Automatically assign plans for your employees worldwide with zero overhead.

Explore Gigs for Work
Gigs Dashboard

The cockpit for your connectivity business. Subscriptions, payments, devices and analytics across multiple carriers and markets - all in one interface.

Explore Dashboard

Web Proxy Viewer  |  New URL  |  Original Page