Packages

Get package details

Retrieves detailed information about a specific package including usage data.

get/profiles/{profileReference}/esims/{esimReference}/packages/{packageReference}

Authorization

Authorization: Bearer {token} — an OAuth2 access token from the client-credentials flow. How authentication works

Path parameters

profileReferencestringrequired

The eSIM's profile reference (16-digit numeric string)

esimReferencestringrequired

eSIM reference identifier (18-digit opaque token)

packageReferencestringrequired

Package reference identifier (23-character opaque token)

Responses

200Package detailsapplication/json

Show response body

dataobject

Show properties

packageReferencestring

Package reference identifier (23-character opaque token)

externalTransactionIdstring | null

The client's external transaction ID if provided

profileReferencestring

externalProfileIdstring | null

The client's external profile ID if provided

esimReferencestring

eSIM reference identifier (18-digit opaque token)

iccidstring

packagePlanobject

Show properties

planReferencestring

Plan reference identifier (14-character opaque token)

namestring

typestring

Package type: data for mobile data, sms for text messaging, voice for calls

Optionsdatasmsvoice

capacityMbnumber | null

speedKbpsnumber | null

smsCountinteger | null

Number of SMS messages included (for SMS packages)

voiceSecondsinteger | null

Voice call seconds included (for voice packages)

validityMinutesinteger

countryCodestring

recurringboolean

typestring

Package type: data for mobile data, sms for text messaging, voice for calls

Optionsdatasmsvoice

countryCodestring

statusstring

Optionsactivethrottledexhaustedexpiredremoved

recurringboolean

Whether this package will auto-renew

activatedAtstring | null · date-time

expiresAtstring | null · date-time

createdAtstring · date-time

usageobject

Usage data for the package

Show properties

totalnumber

Total package capacity (MB for data, count for SMS, seconds for voice)

usednumber

Amount used

remainingnumber

Amount remaining

unitstring

Unit of measurement based on package type

Optionsmbsmsseconds

401Unauthorized - missing or invalid API key 403Forbidden - client does not have access to this resource 404Resource not found 429Rate limit exceeded 500Internal server error

Request

curl 'https://connect.firsty.app/api/v3/profiles/{profileReference}/esims/{esimReference}/packages/{packageReference}' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

fetch('https://connect.firsty.app/api/v3/profiles/{profileReference}/esims/{esimReference}/packages/{packageReference}', {
  headers: {
    Authorization: 'Bearer YOUR_ACCESS_TOKEN'
  }
})

requests.get(
    "https://connect.firsty.app/api/v3/profiles/{profileReference}/esims/{esimReference}/packages/{packageReference}",
    headers={
      "Authorization": "Bearer YOUR_ACCESS_TOKEN"
    }
)

$client = new GuzzleHttp\Client();

$response = $client->request('GET', 'https://connect.firsty.app/api/v3/profiles/{profileReference}/esims/{esimReference}/packages/{packageReference}', [
  'headers' => [
    'Authorization' => 'Bearer YOUR_ACCESS_TOKEN'
  ]
]);

package main

import (
	"fmt"
	"io"
	"net/http"
)

func main() {
	requestUrl := "https://connect.firsty.app/api/v3/profiles/%7BprofileReference%7D/esims/%7BesimReference%7D/packages/%7BpackageReference%7D"

	req, _ := http.NewRequest("GET", requestUrl, nil)

	req.Header.Add("Authorization", "Bearer YOUR_ACCESS_TOKEN")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

curl 'https://connect.test.firsty.app/api/v3/profiles/{profileReference}/esims/{esimReference}/packages/{packageReference}' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

fetch('https://connect.test.firsty.app/api/v3/profiles/{profileReference}/esims/{esimReference}/packages/{packageReference}', {
  headers: {
    Authorization: 'Bearer YOUR_ACCESS_TOKEN'
  }
})

requests.get(
    "https://connect.test.firsty.app/api/v3/profiles/{profileReference}/esims/{esimReference}/packages/{packageReference}",
    headers={
      "Authorization": "Bearer YOUR_ACCESS_TOKEN"
    }
)

$client = new GuzzleHttp\Client();

$response = $client->request('GET', 'https://connect.test.firsty.app/api/v3/profiles/{profileReference}/esims/{esimReference}/packages/{packageReference}', [
  'headers' => [
    'Authorization' => 'Bearer YOUR_ACCESS_TOKEN'
  ]
]);

package main

import (
	"fmt"
	"io"
	"net/http"
)

func main() {
	requestUrl := "https://connect.test.firsty.app/api/v3/profiles/%7BprofileReference%7D/esims/%7BesimReference%7D/packages/%7BpackageReference%7D"

	req, _ := http.NewRequest("GET", requestUrl, nil)

	req.Header.Add("Authorization", "Bearer YOUR_ACCESS_TOKEN")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Response

{
  "data": {
    "packageReference": "C123456XYZDUSR_A1B2C3D4",
    "externalTransactionId": "order-12345",
    "profileReference": "string",
    "externalProfileId": "my-customer-123",
    "esimReference": "123456000000000001",
    "iccid": "string",
    "packagePlan": {
      "planReference": "C123456XYZDUSR",
      "name": "5GB - 30 Days",
      "type": "data",
      "capacityMb": 5120,
      "speedKbps": 100000,
      "smsCount": 0,
      "voiceSeconds": 0,
      "validityMinutes": 43200,
      "countryCode": "US",
      "recurring": true
    },
    "type": "data",
    "countryCode": "string",
    "status": "active",
    "recurring": true,
    "activatedAt": "2026-01-15T09:30:00Z",
    "expiresAt": "2026-01-15T09:30:00Z",
    "createdAt": "2026-01-15T09:30:00Z",
    "usage": {
      "total": 5120,
      "used": 1234.5,
      "remaining": 3885.5,
      "unit": "mb"
    }
  }
}

{
  "type": "https://developers.firsty.app/errors/unauthorized",
  "title": "Unauthorized",
  "status": 401,
  "detail": "Invalid or missing bearer token"
}