# Gigs API Docs > Guides and API reference for the Gigs API, which manages voice and data plans for smartphones, wearables and IoT in 200+ countries. The API is served at https://api.gigs.com. Requests authenticate with an API key as a Bearer token in the `Authorization` header and select the API version with the `Gigs-Version` header, for example `Gigs-Version: 2026-01-29`. Every page below is linked as Markdown; the HTML version has the same URL without `.md`. ## Guides - [Create a subscription](https://developers.gigs.com/docs/create-a-subscription.md): Learn how to create a subscription with the Gigs API. ## Billing - [Billing Users](https://developers.gigs.com/docs/billing/billing-users.md): Learn how to bill your users. - [Credit Notes](https://developers.gigs.com/docs/billing/credit-notes.md): Learn how to issue credit notes for paid invoices. - [Delinquency Management](https://developers.gigs.com/docs/billing/delinquency-management.md): Manage failed payments on recurring subscriptions. - [Subscription Plan Upgrades](https://developers.gigs.com/docs/billing/plan-upgrades.md): Learn how to bill users when they upgrade their subscription plans using the Gigs API. - [Vouchers and Discounts](https://developers.gigs.com/docs/billing/vouchers-and-discounts.md): Learn how to manage vouchers and apply discounts to subscriptions and subscription add-ons. ## Connect - [Connect Links](https://developers.gigs.com/docs/connect/connect-links.md): Learn about Connect Links, the reusable and shareable URLs that launch a pre-configured Connect flow. - [Implement Evergreen Roaming](https://developers.gigs.com/docs/connect/implement-evergreen-roaming.md): Provision a permanent eSIM with the Gigs API, then hand checkout, installation, and support to Gigs Connect for every top-up that follows. ## Connect: Connect sessions - [About](https://developers.gigs.com/docs/connect/connect-sessions/about.md): Learn about Connect Sessions and how they can streamline the user experience. - [Creating Connect Sessions](https://developers.gigs.com/docs/connect/connect-sessions/creating-connect-sessions.md): Learn how to create Connect Sessions and best practices to follow. - [Disable Hosted Connect Login](https://developers.gigs.com/docs/connect/connect-sessions/disable-hosted-connect-login.md): Learn how to disable the hosted Connect login page and redirect users to your application's login page. - [Example Purchasing and Managing](https://developers.gigs.com/docs/connect/connect-sessions/example-purchasing-managing.md): Learn how to purchase and manage subscriptions using Connect Sessions. - [Intent: cancelSubscription](https://developers.gigs.com/docs/connect/connect-sessions/intent-cancelsubscription.md): Learn how to cancel a subscription using the cancelSubscription intent. - [Intent: changeSubscription](https://developers.gigs.com/docs/connect/connect-sessions/intent-changesubscription.md): Learn how to change a subscription using the changeSubscription intent. - [Intent: checkoutAddon](https://developers.gigs.com/docs/connect/connect-sessions/intent-checkoutaddon.md): Learn how to checkout an add-on using the checkoutAddon intent. - [Intent: checkoutNewSubscription](https://developers.gigs.com/docs/connect/connect-sessions/intent-checkoutnewsubscription.md): Learn how to checkout a new subscription using the checkoutNewSubscription intent. - [Intent: completePorting](https://developers.gigs.com/docs/connect/connect-sessions/intent-completeporting.md): Learn how to complete a porting using the completePorting intent. - [Intent: confirmPayment](https://developers.gigs.com/docs/connect/connect-sessions/intent-confirmpayment.md): Learn how to confirm a payment using the confirmPayment intent. - [Intent: replaceSim](https://developers.gigs.com/docs/connect/connect-sessions/intent-replacesim.md): Learn how to let users replace their SIM using the replaceSim intent. - [Intent: requestSupport](https://developers.gigs.com/docs/connect/connect-sessions/intent-requestsupport.md): Learn how to open a support session for a user using the requestSupport intent. - [Intent: resumeSubscription](https://developers.gigs.com/docs/connect/connect-sessions/intent-resumesubscription.md): Learn how to resume a subscription using the resumeSubscription intent. - [Intent: updatePaymentMethod](https://developers.gigs.com/docs/connect/connect-sessions/intent-updatepaymentmethod.md): Learn how to update a payment method using the updatePaymentMethod intent. - [Intent: updateUserAddress](https://developers.gigs.com/docs/connect/connect-sessions/intent-updateuseraddress.md): Learn how to update a user address using the updateUserAddress intent. - [Intent: updateUserFullName](https://developers.gigs.com/docs/connect/connect-sessions/intent-updateuserfullname.md): Learn how to update a user full name using the updateUserFullName intent. - [Intent: viewEsimInstallation](https://developers.gigs.com/docs/connect/connect-sessions/intent-viewesiminstallation.md): Learn how to view the eSIM installation guide using the viewEsimInstallation intent. - [Intent: viewSubscription](https://developers.gigs.com/docs/connect/connect-sessions/intent-viewsubscription.md): Learn how to view a subscription using the viewSubscription intent. - [Intent: viewSubscriptions](https://developers.gigs.com/docs/connect/connect-sessions/intent-viewsubscriptions.md): Learn how to view all subscriptions using the viewSubscriptions intent. - [Linking back to your application from Connect](https://developers.gigs.com/docs/connect/connect-sessions/link-back.md): Learn how to link back to your application from Connect and handle errors. ## Core - [Activate Physical SIMs Inside Devices](https://developers.gigs.com/docs/core/activate-physical-sims.md): Learn how to activate SIM cards when they arrive with a device that has the physical SIM already inserted. - [Add-ons](https://developers.gigs.com/docs/core/add-ons.md): Learn how to extend subscriptions with add-ons, coverage profiles, and travel top-ups using the Gigs API. - [Making changes to an existing subscription](https://developers.gigs.com/docs/core/change-existing-subscriptions.md): Learn how to make changes to an existing subscription on Gigs, such as changing the plan or the SIM. - [Coverage Maps](https://developers.gigs.com/docs/core/coverage-maps.md): Learn how to render a mobile network coverage map in your app or website with the Gigs API. - [eSIM Compatibility Check](https://developers.gigs.com/docs/core/esim-compatibility-check.md): Learn how to check if the user's device support eSIMs for mobile connectivity. - [Implement Unlimited Roaming](https://developers.gigs.com/docs/core/implement-unlimited-roaming.md): Give travelers a fresh high-speed data allowance every day of their trip with recurring add-ons, and keep them connected at a throttled speed once they use it up. - [Metadata](https://developers.gigs.com/docs/core/metadata.md): Get to know metadata on Gigs API resources, and learn how to set and update metadata properties. - [Operations with user consent](https://developers.gigs.com/docs/core/operations-with-user-consent.md): Learn how we ask users for consent for sensitive operations, and how to handle consent requests with the Gigs API. - [Recurring add-ons](https://developers.gigs.com/docs/core/recurring-add-ons.md): Learn how recurring add-ons renew a subscription's allowances automatically for a fixed number of validity periods. - [Lifecycle Reminders](https://developers.gigs.com/docs/core/reminders.md): Learn how to leverage lifecycle reminders to automatically nudge users through the activation process and increase subscription usage. - [SIMs](https://developers.gigs.com/docs/core/sims.md): Learn some of the details around SIMs and how to use them with Gigs API - [User Address Validation](https://developers.gigs.com/docs/core/user-address-validation.md): Learn how user addresses are validated when submitted to the Gigs API, and how to handle validation errors. ## Core: Events - [Events and Webhooks](https://developers.gigs.com/docs/core/events/events-webhooks.md): Learn how to access events and configure webhooks in Gigs. - [Handling Data Change Notifications](https://developers.gigs.com/docs/core/events/handling-data-change-notifications.md): Learn how to handle data change notifications with the Gigs API using events. ## Core: Testing - [Overview](https://developers.gigs.com/docs/core/testing/overview.md): Learn about the tooling we provide to help with testing your integration. - [Test Reminders](https://developers.gigs.com/docs/core/testing/reminders.md): Learn how to test lifecycle reminders. - [Simulate Usage](https://developers.gigs.com/docs/core/testing/simulate-usage.md): Learn about the tooling we provide to test portings in your integration. - [Test Phone Numbers](https://developers.gigs.com/docs/core/testing/test-phone-numbers.md): Learn about the tooling we provide to test portings in your integration. - [Test SIMs](https://developers.gigs.com/docs/core/testing/test-sims.md): Learn about test SIMs and how to test subscription activations via the API. ## Core: Usage - [Introduction to Usage](https://developers.gigs.com/docs/core/usage/introduction.md): Understand what usage information Gigs provides and choose the right API for tracking user data, voice, and SMS consumption. - [Usage API](https://developers.gigs.com/docs/core/usage/apis-for-usage.md): Common API requests for the Usage Balances and Usage API for Usage Records. - [Testing Usage Balances](https://developers.gigs.com/docs/core/usage/testing-usage-balances.md): How to test and simulate usage on Usage Balances - [Usage Balances](https://developers.gigs.com/docs/core/usage/usage-balances-core-concepts.md): Covers the core concepts of the Usage Balances object model. - [Usage Events and Notifications](https://developers.gigs.com/docs/core/usage/usage-events.md): Subscribe to webhook events for usage thresholds, first-use detection, and data throttling on Gigs subscriptions. - [Usage Records](https://developers.gigs.com/docs/core/usage/usage-records-core-concepts.md): Covers the usageRecord object, aggregation modes, filtering, and labels in the Usage API. ## Porting - [How Porting In Works](https://developers.gigs.com/docs/porting/how-porting-in-works.md): Learn how to port a phone number to Gigs using the Gigs API. This guide explains the steps to port a number, including checking eligibility, collecting required information, creating a subscription, dealing with port-in issues, and waiting for completion. - [How Porting Out Works](https://developers.gigs.com/docs/porting/how-porting-out-works.md): Learn how to port a phone number away from Gigs using the Gigs API. This guide explains the steps to create the credentials a user can provide to their new provider to port their phone number. - [Porting in France](https://developers.gigs.com/docs/porting/porting-in-france.md): An in-depth guide to porting in France - [Porting in Ireland](https://developers.gigs.com/docs/porting/porting-in-ireland.md): An in-depth guide to porting in Ireland - [Porting in the UK](https://developers.gigs.com/docs/porting/porting-in-the-uk.md): An in-depth guide to porting in the UK ## Porting: Porting in the US - [Overview](https://developers.gigs.com/docs/porting/porting-in-the-us/overview.md): An in-depth guide to porting in the US - [Locating Account Numbers & Transfer PINs by US Carrier](https://developers.gigs.com/docs/porting/porting-in-the-us/porting-account-number-and-pin-by-carrier.md): Carrier-by-carrier instructions for finding the account number and number transfer PIN needed to port a US phone number, plus recommended account number validation rules. ## API guides - [Introduction](https://developers.gigs.com/api/introduction.md): Learn how to get started with the Gigs API in a few easy steps. - [Application OAuth 2.0](https://developers.gigs.com/api/application-oauth2-authentication.md): Implement machine-to-machine authentication by fetching a short-lived access token. - [Authentication](https://developers.gigs.com/api/authentication.md): Find out how to authenticate against the Gigs API using API keys and what to keep in mind when handling them. - [Error codes](https://developers.gigs.com/api/error-codes.md): A list of error codes that can be returned by the Gigs API, alongside a description of the situation that caused them. - [Error handling](https://developers.gigs.com/api/error-handling.md): Learn how to handle errors when using the Gigs API. - [Idempotent requests](https://developers.gigs.com/api/idempotent-requests.md): Learn how to use idempotency features in the Gigs API. - [OpenAPI](https://developers.gigs.com/api/openapi.md): Gigs OpenAPI documents. - [Pagination](https://developers.gigs.com/api/pagination.md): Learn how to paginate through lists of resources in the Gigs API. - [Rate limiting](https://developers.gigs.com/api/rate-limiting.md): Learn how to handle rate limiting in the Gigs API. - [Versioning](https://developers.gigs.com/api/versioning.md): Get an overview of how to manage Gigs API versions, and which changes are considered backwards-compatible and which are not. ## Gigs Core API - [Overview](https://developers.gigs.com/api/latest/core.md): API to manage voice & data plans for smartphones, wearables and IoT in 200+ countries. - [Add-ons](https://developers.gigs.com/api/latest/core/add-ons.md): Operations to manage add-ons. - [Consent Requests](https://developers.gigs.com/api/latest/core/consent-requests.md): Operations to manage consent requests. - [Devices](https://developers.gigs.com/api/latest/core/devices.md): Operations to manage devices. - [Network Availabilities](https://developers.gigs.com/api/latest/core/network-availabilities.md): Operations to lookup network availability information. - [Plans](https://developers.gigs.com/api/latest/core/plans.md): Operations to manage plans. - [Portings](https://developers.gigs.com/api/latest/core/portings.md): Operations to manage portings. - [Port Outs](https://developers.gigs.com/api/latest/core/port-outs.md): Operations to manage port outs. - [Projects](https://developers.gigs.com/api/latest/core/projects.md): Operations to manage projects. - [SIMs](https://developers.gigs.com/api/latest/core/sims.md): Operations to manage SIMs. - [Subscriptions](https://developers.gigs.com/api/latest/core/subscriptions.md): Operations to manage subscriptions. - [Subscription Add-ons](https://developers.gigs.com/api/latest/core/subscription-add-ons.md): Operations to manage subscription add-ons. - [Subscription Changes](https://developers.gigs.com/api/latest/core/subscription-changes.md): Operations to manage subscription changes. - [Usage](https://developers.gigs.com/api/latest/core/usage.md): View usage records. - [Usage Balances](https://developers.gigs.com/api/latest/core/usage-balances.md): Operations to manage usage balances. - [Users](https://developers.gigs.com/api/latest/core/users.md): Operations to manage users. - [User Addresses](https://developers.gigs.com/api/latest/core/user-addresses.md): Operations to manage user addresses. ## Gigs Payments API - [Overview](https://developers.gigs.com/api/latest/payments.md): Manage orders, payments, and payment methods within Gigs. ## Gigs Connect API - [Overview](https://developers.gigs.com/api/latest/connect.md): Manage sessions for Connect. - [Connect Sessions](https://developers.gigs.com/api/latest/connect/connect-sessions.md): Operations to manage Connect sessions. ## Gigs Billing API - [Overview](https://developers.gigs.com/api/latest/billing.md): Manage invoices and credit notes within Gigs. - [Credit Notes](https://developers.gigs.com/api/latest/billing/credit-notes.md): Operations to manage credit notes. - [Invoices](https://developers.gigs.com/api/latest/billing/invoices.md): Operations to manage invoices. - [Quotes](https://developers.gigs.com/api/latest/billing/quotes.md): Operations to manage quotes. - [Vouchers](https://developers.gigs.com/api/latest/billing/vouchers.md): Operations to manage vouchers. ## Gigs Events - [Overview](https://developers.gigs.com/api/latest/events.md): Events can describe actions, resource state changes, or specific conditions having been met. ## Gigs Reminders - [Overview](https://developers.gigs.com/api/latest/reminders.md): Reminders are automated, time-based notifications to identify when users are stuck and need to take action. ## Latest OpenAPI documents - [Gigs Core API (JSON)](https://api.gigs.com/openapi/core.json) - [Gigs Core API (YAML)](https://api.gigs.com/openapi/core.yaml) - [Gigs Payments API (JSON)](https://api.gigs.com/openapi/payments.json) - [Gigs Payments API (YAML)](https://api.gigs.com/openapi/payments.yaml) - [Gigs Connect API (JSON)](https://api.gigs.com/openapi/connect.json) - [Gigs Connect API (YAML)](https://api.gigs.com/openapi/connect.yaml) - [Gigs Billing API (JSON)](https://api.gigs.com/openapi/billing.json) - [Gigs Billing API (YAML)](https://api.gigs.com/openapi/billing.yaml) - [Gigs Events (JSON)](https://api.gigs.com/openapi/events.json) - [Gigs Events (YAML)](https://api.gigs.com/openapi/events.yaml) - [Gigs Reminders (JSON)](https://api.gigs.com/openapi/reminders.json) - [Gigs Reminders (YAML)](https://api.gigs.com/openapi/reminders.yaml)