Firsty

Search...

Search...

Packages

Get package history

Retrieves a paginated list of all packages for a specific eSIM, including expired and removed packages. Includes usage data for each package. Results are sorted by creation date (newest first).

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

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)

Query parameters

limitinteger

Maximum number of items to return (1-100)

Default20
cursorstring

Opaque cursor token for fetching the next page. Pass the nextCursor value from a previous response.

Responses

200Package historyapplication/json
Show response body
dataarray of PackageHistoryItem
Show properties
packageReferencestring

Package reference identifier (23-character opaque token)

externalTransactionIdstring | null

The client's external transaction ID if provided

planReferencestring

Plan reference identifier (14-character opaque token)

typestring

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

Optionsdatasmsvoice
countryCodestring
statusstring
Optionsactivethrottledexhaustedexpiredremoved
recurringboolean

Whether this package was set to auto-renew

usedAmountnumber

Amount of data used in MB.

remainingAmountnumber | null

Amount of data remaining in MB. Null when not determinable.

usageUpdatedAtstring | null · date-time

When usage was last updated

activatedAtstring | null · date-time
expiresAtstring | null · date-time
createdAtstring · date-time
paginationobject
Show properties
limitintegerrequired

Maximum items per page

hasMorebooleanrequired

Whether there are more items after this page

nextCursorstring | nullrequired

Opaque cursor token for the next page. Null when there are no more results.

401Unauthorized - missing or invalid API key403Forbidden - client does not have access to this resource404Resource not found429Rate limit exceeded500Internal server error