1GLOBAL Connect API (2025-01-28)

Download OpenAPI specification:Download

1GLOBAL Connect is a set of APIs designed for server-to-server integration, accessible over the internet, that enables the provisioning of a variety of connectivity solutions to users.

The main goal of the API is to enable our partners to easily order, activate, and manage 1GLOBAL's global connectivity.

Accounts

Accounts represent business or personal accounts and can have a set of subscribers

Creates a new Account

Authorizations:

oAuth2

header Parameters

Correlation-Id	string An unique identifier provided by the client that allows the request to be traced through the system.
Api-Version	string (ApiVersion) Value: "2025-01-28" This header is used to specify the version of the API being requested. If not specied, the latest version would be used.

Request Body schema: application/json
required

name	string [ 1 .. 100 ] characters
type required	string (AccountType) The account type personal
required	object (CreateAccountOwner)

Responses

Request samples

Payload

Content type

application/json

Example

Create Personal Account Request

{"name": "Test account name",
"type": "personal",
"owner": {"first_name": "First name",
"last_name": "Last Name",
"address": {"line1": "Avenue 1",
"line2": "Central Park",
"city": "Berlin",
"country": "DE",
"postal_code": "123-456"
}
}
}

Response samples

Content type

application/hal+json

Example

Personal Account

{"id": "acc_01J806F9TNFYTQM3Z4THPTJEVY",
"name": "Test account name",
"type": "personal",
"number": "C2024AAAA0000",
"owner": {"first_name": "First name",
"last_name": "Last Name",
"address": {"line1": "Avenue 1",
"line2": "Central Park",
"city": "Berlin",
"country": "DE",
"postal_code": "123-456"
}
},
"created_at": "2024-09-17T14:34:06.037Z",
"updated_at": "2024-09-17T14:34:06.037Z",
"_links": {"self": {"href": "https://api.1global.com/connect/accounts/acc_01J806F9TNFYTQM3Z4THPTJEVY"
}
}
}

List all accounts

Returns a list of accounts

Authorizations:

oAuth2

query Parameters

cursor	string (Cursor) A base64 encoded string that uniquely identifies the first entry of a query result.
limit	integer <int32> (Limit) [ 1 .. 40 ] Default: 10 The page size filter

header Parameters

Correlation-Id	string An unique identifier provided by the client that allows the request to be traced through the system.
Api-Version	string (ApiVersion) Value: "2025-01-28" This header is used to specify the version of the API being requested. If not specied, the latest version would be used.

Responses

Response samples

Content type

application/hal+json

{"_embedded": {"accounts": [{"id": "acc_01BX5ZZKBKACTAV9WEVGEMMVRY",
"name": "string",
"type": "personal",
"number": "string",
"company_name": "string",
"tax_id": "string",
"address": {"line1": "string",
"line2": "string",
"city": "string",
"country": "AD",
"postal_code": 12345
},
"created_at": "2024-10-01T14:28:17.456Z",
"updated_at": "2024-10-01T14:28:17.456Z",
"_links": {"self": {"href": "http://example.com"
}
}
}
]
},
"_links": {"self": {"href": "http://example.com"
},
"next": {"href": "http://example.com"
},
"prev": {"href": "http://example.com"
}
}
}

Retrieve an account

Retrieves the details of an existing account

Authorizations:

oAuth2

path Parameters

account-id

required

string (AccountId) <= 100 characters

Example: acc_01BX5ZZKBKACTAV9WEVGEMMVRY

A string that uniquely identifies an Account

header Parameters

Correlation-Id	string An unique identifier provided by the client that allows the request to be traced through the system.
Api-Version	string (ApiVersion) Value: "2025-01-28" This header is used to specify the version of the API being requested. If not specied, the latest version would be used.

Responses

Response samples

Content type

application/hal+json

Example

Personal Account

{"id": "acc_01J806F9TNFYTQM3Z4THPTJEVY",
"name": "Test account name",
"type": "personal",
"number": "C2024AAAA0000",
"owner": {"first_name": "First name",
"last_name": "Last Name",
"address": {"line1": "Avenue 1",
"line2": "Central Park",
"city": "Berlin",
"country": "DE",
"postal_code": "123-456"
}
},
"created_at": "2024-09-17T14:34:06.037Z",
"updated_at": "2024-09-17T14:34:06.037Z",
"_links": {"self": {"href": "https://api.1global.com/connect/accounts/acc_01J806F9TNFYTQM3Z4THPTJEVY"
}
}
}

Patch an account

Authorizations:

oAuth2

path Parameters

account-id

required

string (AccountId) <= 100 characters

Example: acc_01BX5ZZKBKACTAV9WEVGEMMVRY

A string that uniquely identifies an Account

header Parameters

Correlation-Id	string An unique identifier provided by the client that allows the request to be traced through the system.
Api-Version	string (ApiVersion) Value: "2025-01-28" This header is used to specify the version of the API being requested. If not specied, the latest version would be used.

Request Body schema: application/json
required

One of

name	string
	object (PatchAccountOwner)

Responses

Request samples

Payload

Content type

application/json

Example

Patch Personal Account Request

{"owner": {"address": {"line1": "Avenue 1",
"line2": "Central Park",
"city": "Berlin",
"country": "DE",
"postal_code": "123-456"
}
}
}

Response samples

Content type

application/hal+json

Example

Personal Account

{"id": "acc_01J806F9TNFYTQM3Z4THPTJEVY",
"name": "Test account name",
"type": "personal",
"number": "C2024AAAA0000",
"owner": {"first_name": "First name",
"last_name": "Last Name",
"address": {"line1": "Avenue 1",
"line2": "Central Park",
"city": "Berlin",
"country": "DE",
"postal_code": "123-456"
}
},
"created_at": "2024-09-17T14:34:06.037Z",
"updated_at": "2024-09-17T14:34:06.037Z",
"_links": {"self": {"href": "https://api.1global.com/connect/accounts/acc_01J806F9TNFYTQM3Z4THPTJEVY"
}
}
}

Contracts

Contract represent a legal agreement between a customer and a service provider

List all Contracts

Returns a list of Contracts

Authorizations:

oAuth2

query Parameters

limit	integer <int32> (Limit) [ 1 .. 40 ] Default: 10 The page size filter
cursor	string (Cursor) A base64 encoded string that uniquely identifies the first entry of a query result.
account-id	string (AccountId) <= 100 characters Example: account-id=acc_01BX5ZZKBKACTAV9WEVGEMMVRY A string that uniquely identifies an Account

header Parameters

Correlation-Id	string An unique identifier provided by the client that allows the request to be traced through the system.
Api-Version	string (ApiVersion) Value: "2025-01-28" This header is used to specify the version of the API being requested. If not specied, the latest version would be used.

Responses

Response samples

Content type

application/hal+json

{"_embedded": {"contracts": [{"id": "con_1234",
"type": "contract_summary",
"created_at": "2024-08-30T10:42:34.309Z",
"_embedded": {"account": {"id": "acc_01HRC2T6WK4CMVGFXA2RESTQ97",
"_links": {"self": {"href": "https://api.1global.com/connect/accounts/acc_01HRC2T6WK4CMVGFXA2RESTQ97"
}
}
},
"order": {"id": "ord_01HRC2T6WK4CMVGFXA2RESTQ97",
"_links": {"self": {"href": "https://api.1global.com/connect/orders/ord_01HRC2T6WK4CMVGFXA2RESTQ97"
}
}
}
},
"_links": {"self": {"href": "https://api.1global.com/connect/contracts/con_1234"
}
}
}
]
},
"_links": {"self": {"href": "https://api.1global.com/connect/contracts"
},
"next": {"href": "https://api.1global.com/connect/contracts?cursor=nextCursor"
},
"prev": {"href": "https://api.1global.com/connect/contracts?cursor=prevCursor"
}
}
}

Retrieve a contract

Retrieves a contract by its ID

Authorizations:

oAuth2

path Parameters

contract-id

required

string (ContractId) <= 100 characters

Example: con_02HV3KWPNICT800WV3XG41CAT5

The resource identifier.

header Parameters

Correlation-Id	string An unique identifier provided by the client that allows the request to be traced through the system.
Api-Version	string (ApiVersion) Value: "2025-01-28" This header is used to specify the version of the API being requested. If not specied, the latest version would be used.

Responses

Response samples

Content type

application/hal+json

{"id": "con_1234",
"type": "contract_summary",
"created_at": "2024-08-30T10:42:34.309Z",
"_embedded": {"account": {"id": "acc_01HRC2T6WK4CMVGFXA2RESTQ97",
"_links": {"self": {"href": "https://api.1global.com/connect/accounts/acc_01HRC2T6WK4CMVGFXA2RESTQ97"
}
}
},
"order": {"id": "ord_01HRC2T6WK4CMVGFXA2RESTQ97",
"_links": {"self": {"href": "https://api.1global.com/connect/orders/ord_01HRC2T6WK4CMVGFXA2RESTQ97"
}
}
}
},
"_links": {"self": {"href": "https://api.1global.com/connect/contracts/con_1234"
},
"download": {"href": "https://api.1global.com/a-resource/con_01HRC2T6WK4CMVGFXA2RESTQ97"
}
}
}

Coverage Areas

A Coverage Area defines the country (or countries) where a Product Offering can be used

List all Coverage Areas

Returns a list of coverage areas

Authorizations:

oAuth2

query Parameters

countries	Array of strings (Country) Items Enum: "AD" "AE" "AF" "AG" "AI" "AL" "AM" "AO" "AQ" "AR" "AS" "AT" "AU" "AW" "AX" "AZ" "BA" "BB" "BD" "BE" "BF" "BG" "BH" "BI" "BJ" "BL" "BM" "BN" "BO" "BQ" "BR" "BS" "BT" "BV" "BW" "BY" "BZ" "CA" "CC" "CD" "CF" "CG" "CH" "CK" "CL" "CM" "CN" "CO" "CR" "CU" "CV" "CW" "CX" "CY" "CZ" "DE" "DJ" "DK" "DM" "DO" "DZ" "EC" "EE" "EG" "EH" "ER" "ES" "ET" "FI" "FJ" "FK" "FM" "FO" "FR" "GA" "GB" "GD" "GE" "GF" "GG" "GH" "GI" "GL" "GM" "GN" "GP" "GQ" "GR" "GS" "GT" "GU" "GW" "GY" "HK" "HM" "HN" "HR" "HT" "HU" "ID" "IE" "IL" "IM" "IN" "IO" "IQ" "IR" "IS" "IT" "JE" "JM" "JO" "JP" "KE" "KG" "KH" "KI" "KM" "KN" "KP" "KR" "KW" "KY" "KZ" "LA" "LB" "LC" "LI" "LK" "LR" "LS" "LT" "LU" "LV" "LY" "MA" "MC" "MD" "ME" "MF" "MG" "MH" "MK" "ML" "MM" "MN" "MO" "MP" "MQ" "MR" "MS" "MT" "MU" "MV" "MW" "MX" "MY" "MZ" "NA" "NC" "NE" "NF" "NG" "NI" "NL" "NO" "NP" "NR" "NU" "NZ" "OM" "PA" "PE" "PF" "PG" "PH" "PK" "PL" "PM" "PN" "PR" "PS" "PT" "PW" "PY" "QA" "RE" "RO" "RS" "RU" "RW" "SA" "SB" "SC" "SD" "SE" "SG" "SH" "SI" "SJ" "SK" "SL" "SM" "SN" "SO" "SR" "SS" "ST" "SV" "SX" "SY" "SZ" "TC" "TD" "TF" "TG" "TH" "TJ" "TK" "TL" "TM" "TN" "TO" "TR" "TT" "TV" "TW" "TZ" "UA" "UG" "UM" "US" "UY" "UZ" "VC" "VE" "VG" "VI" "VN" "VU" "WF" "WS" "XK" "YE" "YT" "ZA" "ZM" "ZW" Countries filter.
cursor	string (Cursor) A base64 encoded string that uniquely identifies the first entry of a query result.
limit	integer <int32> (Limit) [ 1 .. 40 ] Default: 10 The page size filter

header Parameters

Correlation-Id	string An unique identifier provided by the client that allows the request to be traced through the system.
Api-Version	string (ApiVersion) Value: "2025-01-28" This header is used to specify the version of the API being requested. If not specied, the latest version would be used.

Responses

Response samples

Content type

application/hal+json

{"_embedded": {"coverage_areas": [{"id": "cov_01J83E2VNKR4GD78MF1R43YWTK",
"name": "Portugal",
"type": "local",
"created_at": "2024-09-18T20:44:50.227Z",
"updated_at": "2024-09-20T12:42:12.987Z",
"countries": ["PT"
],
"_links": {"self": {"href": "https://api.1global.com/connect/coverage-areas/cov_01J83E2VNKR4GD78MF1R43YWTK"
}
}
},
{"id": "cov_01J83E2VNKR4GD78MF1R43YIW3",
"name": "Spain",
"type": "local",
"created_at": "2024-01-14T20:44:50.098Z",
"updated_at": "2024-04-23T01:23:10.234Z",
"countries": ["ES"
],
"_links": {"self": {"href": "https://api.1global.com/connect/coverage-areas/cov_01J83E2VNKR4GD78MF1R43YIW3"
}
}
}
]
},
"_links": {"self": {"href": "https://api.1global.com/connect/coverage-areas?limit=2"
},
"prev": {"href": "https://api.1global.com/connect/coverage-areas?cursor=eyJzbyI6eyJkIjoiREVTQyIsInAiOiJleHRlcm5hbElkIn0sInNpZCI6bnVsbCwicyI6bnVsbCwidCI6Ik5FWFQiLCJpZCI6InN1YnNfMDFKQTVESzdEOFBEQ0hTSDI3RjMzUjVXNDYifQ==&limit=2"
},
"next": {"href": "https://api.1global.com/connect/coverage-areas?cursor=eyJzbyI6eyJkIjoiREVTQyIsInAiOiJleHRlcm5hbElkIn0sInNpZCI6bnVsbCwicyI6bnVsbCwidCI6Ik5FWFQiLCJpZCI6InN1YnNfMDFKQTVESzdEOFBEQ0hTSDI3RjMzUjVXNDYifQ==&limit=2"
}
}
}

Retrieve a Coverage Area

Retrieves the details of an existing coverage area.

Authorizations:

oAuth2

path Parameters

coverage-area-id

required

string (CoverageAreaId) <= 100 characters

Example: cov_01BX5ZZKBKACTAV9WEVGEMMVRY

An identifier of the coverage area.

header Parameters

Correlation-Id	string An unique identifier provided by the client that allows the request to be traced through the system.
Api-Version	string (ApiVersion) Value: "2025-01-28" This header is used to specify the version of the API being requested. If not specied, the latest version would be used.

Responses

Response samples

Content type

application/hal+json

{"id": "cov_01BX5ZZKBKACTAV9WEVGEMMVRY",
"name": "Local pt",
"type": "local",
"created_at": "2024-02-01T14:28:17.967Z",
"updated_at": "2024-03-01T15:28:00.127Z",
"countries": ["PT"
],
"_links": {"self": {"href": "https://api.1global.com/connect/coverage-areas/cov_01BX5ZZKBKACTAV9WEVGEMMVRY"
}
}
}

Invoices

Invoices represent the billing of a set of products and services

List all Invoices

Returns a list of Invoices

Authorizations:

oAuth2

query Parameters

limit	integer <int32> (Limit) [ 1 .. 40 ] Default: 10 The page size filter
cursor	string (Cursor) A base64 encoded string that uniquely identifies the first entry of a query result.
account-id	string (AccountId) <= 100 characters Example: account-id=acc_01BX5ZZKBKACTAV9WEVGEMMVRY A string that uniquely identifies an Account

header Parameters

Correlation-Id	string An unique identifier provided by the client that allows the request to be traced through the system.
Api-Version	string (ApiVersion) Value: "2025-01-28" This header is used to specify the version of the API being requested. If not specied, the latest version would be used.

Responses

Response samples

Content type

application/hal+json

{"_embedded": {"invoices": [{"id": "inv_1234",
"number": "INV-2025-001",
"total": {"amount": 5400,
"currency": "EUR"
},
"period": "2025-02-10T00:00:00Z/2025-02-15T23:59:59Z",
"_embedded": {"account": {"id": "acc_01BX5ZZKBKACTAV9WEVGEMMVRY",
"_links": {"self": {"href": "https://api.1global.com/connect/accounts/acc_01BX5ZZKBKACTAV9WEVGEMMVRY"
}
}
}
},
"_links": {"self": {"href": "https://api.1global.com/connect/invoices/inv_1234"
}
}
}
]
},
"_links": {"self": {"href": "https://api.1global.com/connect/invoices"
},
"next": {"href": "https://api.1global.com/connect/invoices?cursor=nextCursor"
},
"prev": {"href": "https://api.1global.com/connect/invoices?cursor=prevCursor"
}
}
}

Retrieve a invoice

Retrieves a invoice by its ID

Authorizations:

oAuth2

path Parameters

invoice-id

required

string (InvoiceId) <= 100 characters

Example: inv_02HV3KWPNICT800WV3XG41CAT5

The resource identifier.

header Parameters

Correlation-Id	string An unique identifier provided by the client that allows the request to be traced through the system.
Api-Version	string (ApiVersion) Value: "2025-01-28" This header is used to specify the version of the API being requested. If not specied, the latest version would be used.

Responses

Response samples

Content type

application/hal+json

{"id": "inv_1234",
"status": "paid",
"created_at": "2024-10-01T14:28:17.456Z",
"number": "INV-2025-001",
"period": "2025-02-10T00:00:00Z/2025-02-15T23:59:59Z",
"total": {"amount": 5400,
"currency": "EUR"
},
"amount_breakdown": [{"type": "recurring",
"total": {"amount": 2400,
"currency": "EUR"
}
},
{"type": "sms_oob",
"total": {"amount": 600,
"currency": "EUR"
}
},
{"type": "voice_oob",
"total": {"amount": 1200,
"currency": "EUR"
}
},
{"type": "one_off",
"total": {"amount": 1200,
"currency": "EUR"
}
}
],
"_embedded": {"account": {"id": "acc_01BX5ZZKBKACTAV9WEVGEMMVRY",
"_links": {"self": {"href": "https://api.1global.com/connect/accounts/acc_01BX5ZZKBKACTAV9WEVGEMMVRY"
}
}
}
},
"_links": {"self": {"href": "https://api.1global.com/connect/invoices/inv_1234"
},
"download": {"href": "http://api.1global.com/a-resource/inv_01HRC2T6WK4CMVGFXA2RESTQ97"
}
}
}

List all Invoices Items

Returns a list of Invoice Items

Authorizations:

oAuth2

path Parameters

invoice-id

required

string (InvoiceId) <= 100 characters

Example: inv_02HV3KWPNICT800WV3XG41CAT5

The resource identifier.

query Parameters

limit	integer <int32> (Limit) [ 1 .. 40 ] Default: 10 The page size filter
cursor	string (Cursor) A base64 encoded string that uniquely identifies the first entry of a query result.

header Parameters

Correlation-Id	string An unique identifier provided by the client that allows the request to be traced through the system.
Api-Version	string (ApiVersion) Value: "2025-01-28" This header is used to specify the version of the API being requested. If not specied, the latest version would be used.

Responses

Response samples

Content type

application/hal+json

{"_embedded": {"items": [{"type": "recurring",
"total": {"amount": 2400,
"currency": "EUR"
},
"period": "2025-02-10T00:00:00Z/2025-02-15T23:59:59Z",
"subtotal": {"amount": 2000,
"currency": "EUR"
},
"tax": {"amount": 400,
"currency": "EUR"
},
"_embedded": {"subscription": {"id": "sub_41BX5ZZKBKACTAV9WEVGEMMVRZ",
"_links": {"self": {"href": "https://api.1global.com/connect/subscriptions/sub_41BX5ZZKBKACTAV9WEVGEMMVRZ"
}
}
},
"product": {"id": "prod_01BX5ZZKBKACTAV9WEVGEMMVRY",
"_links": {"self": {"href": "https://api.1global.com/connect/products/prod_01BX5ZZKBKACTAV9WEVGEMMVRY"
}
}
}
}
},
{"type": "sms_oob",
"total": {"amount": 1200,
"currency": "EUR"
},
"period": "2025-02-10T00:00:00Z/2025-02-15T23:59:59Z",
"subtotal": {"amount": 1000,
"currency": "EUR"
},
"tax": {"amount": 200,
"currency": "EUR"
},
"_embedded": {"subscription": {"id": "sub_41BX5ZZKBKACTAV9WEVGEMMVRZ",
"_links": {"self": {"href": "https://api.1global.com/connect/subscriptions/sub_41BX5ZZKBKACTAV9WEVGEMMVRZ"
}
}
}
}
}
]
},
"_links": {"self": {"href": "https://api.1global.com/connect/invoices/inv_1234/items"
},
"next": {"href": "https://api.1global.com/connect/invoices/inv_1234/items?cursor=nextCursor"
},
"prev": {"href": "https://api.1global.com/connect/invoices/inv_1234/items?cursor=prevCursor"
}
}
}

Network Operators

List all network-operators

Returns a list of network-operators

Authorizations:

oAuth2

query Parameters

limit	integer <int32> (Limit) [ 1 .. 40 ] Default: 10 The page size filter
cursor	string (Cursor) A base64 encoded string that uniquely identifies the first entry of a query result.
country	string (PortingCountry) Value: "DE" The supported country codes according to ISO 3166-1 alpha-2
status	string (NetworkOperatorStatus) Enum: "active" "inactive"

header Parameters

Correlation-Id	string An unique identifier provided by the client that allows the request to be traced through the system.
Api-Version	string (ApiVersion) Value: "2025-01-28" This header is used to specify the version of the API being requested. If not specied, the latest version would be used.

Responses

Response samples

Content type

application/hal+json

{"_embedded": {"network_operators": [{"id": "nopr_01J6795M195EXEECTPY9Y3QD66",
"name": "Truphone",
"trade_name": "Truphone",
"country": "DE",
"status": "active",
"created_at": "2024-08-30T10:42:34.309Z",
"updated_at": "2024-08-30T10:42:34.309Z",
"_links": {"self": {"href": "https://api.1global.com/connect/network-operators/nopr_01J6795M195EXEECTPY9Y3QD66"
}
}
},
{"id": "nopr_01JGYX8WRXYFT2GX3MVAKG8NPZ",
"name": "T-Mobile Deutschland GmbH",
"trade_name": "Telekom",
"country": "DE",
"status": "active",
"created_at": "2024-08-30T10:42:34.309Z",
"updated_at": "2024-08-30T10:42:34.309Z",
"_links": {"self": {"href": "https://api.1global.com/connect/network-operators/nopr_01J6795M195EXEECTPY9Y3QD66"
}
}
}
]
},
"_links": {"self": {"href": "https://api.1global.com/connect/network-operators"
},
"next": {"href": "https://api.1global.com/connect/network-operators?cursor=nextCursor&limit=2"
},
"prev": {"href": "https://api.1global.com/connect/network-operators?cursor=prevCursor&limit=2"
}
}
}

Get a network-operators by id

Get a network operator by id

Authorizations:

oAuth2

path Parameters

network-operator-id

required

string (NetworkOperatorId) <= 100 characters

Example: nopr_01HV3KWPNRCT870WV3XG41CAT3

The resource identifier.

header Parameters

Correlation-Id	string An unique identifier provided by the client that allows the request to be traced through the system.
Api-Version	string (ApiVersion) Value: "2025-01-28" This header is used to specify the version of the API being requested. If not specied, the latest version would be used.

Responses

Response samples

Content type

application/hal+json

{"id": "nopr_01HV3KWPNRCT870WV3XG41CAT3",
"name": "T-Mobile Deutschland GmbH",
"trade_name": "Telekom",
"country": "DE",
"status": "active",
"created_at": "2024-10-01T14:28:17.456Z",
"updated_at": "2024-10-01T14:28:17.456Z",
"_links": {"self": {"href": "https://api.1global.com/connect/network-operators/nopr_01HV3KWPNRCT870WV3XG41CAT3"
}
}
}

Orders

Orders are used to make purchases of products within a subscription

Creates a new Order

Creates a new order for a subscriber.

Authorizations:

oAuth2

header Parameters

Correlation-Id	string An unique identifier provided by the client that allows the request to be traced through the system.
Api-Version	string (ApiVersion) Value: "2025-01-28" This header is used to specify the version of the API being requested. If not specied, the latest version would be used.

Request Body schema: application/json
required

One of

type required	string Value: "activate_subscription" The Order type
subscriber_id required	string (SubscriberId) <= 100 characters The Subscriber Id
purchase_location required	string (Country) Enum: "AD" "AE" "AF" "AG" "AI" "AL" "AM" "AO" "AQ" "AR" "AS" "AT" "AU" "AW" "AX" "AZ" "BA" "BB" "BD" "BE" "BF" "BG" "BH" "BI" "BJ" "BL" "BM" "BN" "BO" "BQ" "BR" "BS" "BT" "BV" "BW" "BY" "BZ" "CA" "CC" "CD" "CF" "CG" "CH" "CK" "CL" "CM" "CN" "CO" "CR" "CU" "CV" "CW" "CX" "CY" "CZ" "DE" "DJ" "DK" "DM" "DO" "DZ" "EC" "EE" "EG" "EH" "ER" "ES" "ET" "FI" "FJ" "FK" "FM" "FO" "FR" "GA" "GB" "GD" "GE" "GF" "GG" "GH" "GI" "GL" "GM" "GN" "GP" "GQ" "GR" "GS" "GT" "GU" "GW" "GY" "HK" "HM" "HN" "HR" "HT" "HU" "ID" "IE" "IL" "IM" "IN" "IO" "IQ" "IR" "IS" "IT" "JE" "JM" "JO" "JP" "KE" "KG" "KH" "KI" "KM" "KN" "KP" "KR" "KW" "KY" "KZ" "LA" "LB" "LC" "LI" "LK" "LR" "LS" "LT" "LU" "LV" "LY" "MA" "MC" "MD" "ME" "MF" "MG" "MH" "MK" "ML" "MM" "MN" "MO" "MP" "MQ" "MR" "MS" "MT" "MU" "MV" "MW" "MX" "MY" "MZ" "NA" "NC" "NE" "NF" "NG" "NI" "NL" "NO" "NP" "NR" "NU" "NZ" "OM" "PA" "PE" "PF" "PG" "PH" "PK" "PL" "PM" "PN" "PR" "PS" "PT" "PW" "PY" "QA" "RE" "RO" "RS" "RU" "RW" "SA" "SB" "SC" "SD" "SE" "SG" "SH" "SI" "SJ" "SK" "SL" "SM" "SN" "SO" "SR" "SS" "ST" "SV" "SX" "SY" "SZ" "TC" "TD" "TF" "TG" "TH" "TJ" "TK" "TL" "TM" "TN" "TO" "TR" "TT" "TV" "TW" "TZ" "UA" "UG" "UM" "US" "UY" "UZ" "VC" "VE" "VG" "VI" "VN" "VU" "WF" "WS" "XK" "YE" "YT" "ZA" "ZM" "ZW" The supported country codes according to ISO 3166-1 alpha-2
required	object The SIM Profile of this Subscription
	object (Device) The Device where the SIM Profile is installed
required	object (OrderProductsActivation) The products to buy with this order.

Responses

Request samples

Payload

Content type

application/json

Example

Activate Subscription Order - First Usage

{"type": "activate_subscription",
"subscriber_id": "subr_01HXF4F4VYTCPVMBPBK3T52TN7",
"purchase_location": "US",
"sim_profile": {"sim_type": "esim"
},
"products": {"plan": {"product_offering_id": "prdoff_01HRD00B0K1EPRZ9WEVGEMUIJ6E"
},
"addons": [{"activation_mode": "first_usage",
"product_offering_id": "prdoff_01HRD00B0K1EPRZ91XEFRYPPTVX"
}
]
}
}

Response samples

Content type

application/hal+json

{"id": "ord_01HV3KWPNRCT870WV3XG41UTG4",
"status": "accepted",
"type": "activate_subscription",
"created_at": "2024-08-02T09:13:28.384Z",
"_links": {"self": {"href": "https://api.1global.com/orders/ord_01HV3KWPNRCT870WV3XG41UTG4"
},
"subscriber": {"href": "https://api.1global.com/subscribers/subr_01J494G6WZAR2E2808Z8M07K4Z"
}
}
}

List all Orders

Returns a list of orders

Authorizations:

oAuth2

query Parameters

cursor	string (Cursor) A base64 encoded string that uniquely identifies the first entry of a query result.
limit	integer <int32> (Limit) [ 1 .. 40 ] Default: 10 The page size filter
status	string (OrderStatus) Enum: "accepted" "fulfilling" "completed" "failed" Example: status=completed The Order status

header Parameters

Correlation-Id	string An unique identifier provided by the client that allows the request to be traced through the system.
Api-Version	string (ApiVersion) Value: "2025-01-28" This header is used to specify the version of the API being requested. If not specied, the latest version would be used.

Responses

Response samples

Content type

application/hal+json

{"_embedded": {"orders": [{"id": "ord_01HV3KWPNRCT870WV3XG41CAT3",
"status": "completed",
"type": "activate_subscription",
"created_at": "2024-08-02T09:13:28.384Z",
"updated_at": "2024-08-02T09:15:30.544Z",
"completed_at": "2024-08-02T09:20:30.000Z",
"_links": {"self": {"href": "https://api.1global.com/orders/ord_01HV3KWPNRCT870WV3XG41CAT3"
},
"subscriber": {"href": "https://api.1global.com/subscribers/subr_01J494G6WZAR2E2808Z8M07K4Z"
}
}
},
{"id": "ord_01HV3KWPNRCT870WV3XG41UTG4",
"status": "failed",
"type": "topup_subscription",
"created_at": "2024-08-02T09:13:28.384Z",
"updated_at": "2024-08-02T09:18:30.544Z",
"_links": {"self": {"href": "https://api.1global.com/orders/ord_01HV3KWPNRCT870WV3XG41UTG4"
},
"subscriber": {"href": "https://api.1global.com/subscribers/subr_01J494G6WZAR2E2808Z8M07K4Z"
}
}
}
]
},
"_links": {"self": {"href": "https://api.1global.com/connect/orders?limit=2"
},
"prev": {"href": "https://api.1global.com/connect/orders?cursor=eyJzbyI6eyJkIjoiREVTQyIsInAiOiJleHRlcm5hbElkIn0sInNpZCI6bnVsbCwicyI6bnVsbCwidCI6Ik5FWFQiLCJpZCI6InN1YnNfMDFKQTVESzdEOFBEQ0hTSDI3RjMzUjVXNDYifQ==&limit=2"
},
"next": {"href": "https://api.1global.com/connect/orders?cursor=eyJzbyI6eyJkIjoiREVTQyIsInAiOiJleHRlcm5hbElkIn0sInNpZCI6bnVsbCwicyI6bnVsbCwidCI6Ik5FWFQiLCJpZCI6InN1YnNfMDFKQTVESzdEOFBEQ0hTSDI3RjMzUjVXNDYifQ==&limit=2"
}
}
}

Retrieve an Order

Retrieves the details of an existing order

Authorizations:

oAuth2

path Parameters

order-id

required

string (OrderId) <= 100 characters

Example: ord_01HV3KWPNRCT870WV3XG41CAT3

An identifier of the order.

header Parameters

Correlation-Id	string An unique identifier provided by the client that allows the request to be traced through the system.
Api-Version	string (ApiVersion) Value: "2025-01-28" This header is used to specify the version of the API being requested. If not specied, the latest version would be used.

Responses

Response samples

Content type

application/hal+json

{"id": "ord_01HV3KWPNRCT870WV3XG41CAT3",
"status": "completed",
"type": "topup_subscription",
"created_at": "2024-08-02T09:13:28.384Z",
"updated_at": "2024-08-02T09:13:30.544Z",
"completed_at": "2024-08-02T09:13:35.122Z",
"_embedded": {"subscription": {"id": "subs_01HRCZZWCBXR40JQ6B705952WJ",
"status": "active",
"created_at": "2024-07-11T10:29:42.426Z",
"_embedded": {"sim_profile": {"iccid": "8988211234567890023",
"sim_type": "esim",
"profile_status": "Installed",
"matching_id": "5C-ZYXZZ-1R54O94",
"smdp_address": "rsp.truphone.com",
"_embedded": {"device": {"uicc": {"eid": "89049032007208882600182092769530"
}
}
}
},
"account": {"id": "acc_01HRC2T6WK4CMVGFXA2RESTQ97",
"_links": {"self": {"href": "http://api.1global.com/connect/accounts/acc_01HRC2T6WK4CMVGFXA2RESTQ97"
}
}
}
},
"_links": {"self": {"href": "https://api.1global.com/subscriptions/subs_01HRCZZWCBXR40JQ6B705952WJ"
},
"qrcode": {"href": "https://api.1global.com/qrcode/v1/esim/LPA:1$rsp.truphone.com$5C-ZYXZZ-1R54O94"
}
}
}
},
"_links": {"self": {"href": "https://api.1global.com/orders/ord_01HV3KWPNRCT870WV3XG41CAT3"
},
"subscriber": {"href": "https://api.1global.com/subscribers/subr_01J494G6WZAR2E2808Z8M07K4Z"
}
}
}

Phone Numbers

List Phone Numbers

List phone numbers

Authorizations:

oAuth2

query Parameters

limit	integer <int32> (Limit) [ 1 .. 40 ] Default: 10 The page size filter
cursor	string (Cursor) A base64 encoded string that uniquely identifies the first entry of a query result.
subscription-id	string (SubscriptionId) <= 100 characters Example: subscription-id=subs_01J9XJ11WTYFWFH5JD2YM1S18S A string that uniquely identifies a Subscription

header Parameters

Correlation-Id	string An unique identifier provided by the client that allows the request to be traced through the system.
Api-Version	string (ApiVersion) Value: "2025-01-28" This header is used to specify the version of the API being requested. If not specied, the latest version would be used.

Responses

Response samples

Content type

application/hal+json

{"_embedded": {"phone_numbers": [{"id": "pn_01BX5ZZKBKACTAV9WEVGEMUIJ6",
"status": "active",
"created_at": "2024-01-01T00:00:00.100Z",
"updated_at": "2024-05-21T00:00:00.500Z",
"msisdn": "+4912984900817",
"country": "DE",
"is_primary": true,
"_links": {"self": {"href": "https://api.1global.com/connect/phone-numbers/pn_01BX5ZZKBKACTAV9WEVGEMUIJ6"
},
"disable-porting-opt-in": {"href": "https://api.1global.com/connect/phone-numbers/pn_01BX5ZZKBKACTAV9WEVGEMUIJ6/disable-porting-opt-in"
},
"subscription": {"href": "https://api.1global.com/connect/subscriptions/subs_02BX5ZZKBKACTAV9WEVGEMMVZS"
}
}
},
{"id": "pn_01BX5ZZKBKACTAV9WEVGEMUIJ6",
"status": "terminated",
"created_at": "2023-01-01T00:00:00.100Z",
"updated_at": "2023-05-21T00:00:00.500Z",
"msisdn": "+4912984900817",
"country": "DE",
"is_primary": true,
"_links": {"self": {"href": "https://api.1global.com/connect/phone-numbers/pn_01BX5ZZKBKACTAV9WEVGEMUIJ6"
},
"subscription": {"href": "https://api.1global.com/connect/subscriptions/subs_02BX5ZZKBKACTAV9WEVGEMMVZS"
}
}
}
]
},
"_links": {"self": {"href": "http://api.1global.com/connect/phone-numbers"
},
"prev": {"href": "http://api.1global.com/connect/phone-numbers?cursor=eyJzbyI6eyJkIjoiREVTQyIsInAiOiJleHRlcm5hbElkIn0sInNpZCI6bnVsbCwicyI6bnVsbCwidCI6Ik5FWFQiLCJpZCI6InN1YnNfMDFKQTVESzdEOFBEQ0hTSDI3RjMzUjVXNDYifQ==&limit=10"
},
"next": {"href": "http://api.1global.com/connect/phone-numbers?cursor=eyJzbyI6eyJkIjoiREVTQyIsInAiOiJleHRlcm5hbElkIn0sInNpZCI6bnVsbCwicyI6bnVsbCwidCI6Ik5FWFQiLCJpZCI6InN1YnNfMDFKQTVESzdEOFBEQ0hTSDI3RjMzUjVXNDYifQ==&limit=10"
}
}
}

Retrieve a Phone Number

Retrieves the details of an existing Phone Number

Authorizations:

oAuth2

path Parameters

phone-number-id

required

string (PhoneNumberId) <= 100 characters

Example: pn_01BX5ZZKBKACTAV9WEVGEMMVL6

A string that uniquely identifies a Phone Number

header Parameters

Correlation-Id	string An unique identifier provided by the client that allows the request to be traced through the system.
Api-Version	string (ApiVersion) Value: "2025-01-28" This header is used to specify the version of the API being requested. If not specied, the latest version would be used.

Responses

Response samples

Content type

application/hal+json

Example

Phone Number - active (opt in enabled)

{"id": "pn_01BX5ZZKBKACTAV9WEVGEMUIJ6",
"status": "active",
"created_at": "2024-01-01T00:00:00.100Z",
"updated_at": "2024-05-21T00:00:00.500Z",
"msisdn": "+4912984900817",
"country": "DE",
"is_primary": true,
"porting_opt_in": {"enabled": true,
"expires_at": "2025-01-03T00:00:00.500Z"
},
"_links": {"self": {"href": "https://api.1global.com/connect/phone-numbers/pn_01BX5ZZKBKACTAV9WEVGEMUIJ6"
},
"disable-porting-opt-in": {"href": "https://api.1global.com/connect/phone-numbers/pn_01BX5ZZKBKACTAV9WEVGEMUIJ6/disable-porting-opt-in"
},
"subscription": {"href": "https://api.1global.com/connect/subscriptions/subs_02BX5ZZKBKACTAV9WEVGEMMVZS"
}
}
}

Enable Phone Number Opt In

Enables the Phone Number porting Opt In

Authorizations:

oAuth2

path Parameters

phone-number-id

required

string (PhoneNumberId) <= 100 characters

Example: pn_01BX5ZZKBKACTAV9WEVGEMMVL6

A string that uniquely identifies a Phone Number

header Parameters

Correlation-Id	string An unique identifier provided by the client that allows the request to be traced through the system.
Api-Version	string (ApiVersion) Value: "2025-01-28" This header is used to specify the version of the API being requested. If not specied, the latest version would be used.

Responses

Response samples

Content type

application/hal+json

{"id": "pn_01BX5ZZKBKACTAV9WEVGEMUIJ6",
"status": "active",
"created_at": "2024-01-01T00:00:00.100Z",
"updated_at": "2024-05-21T00:00:00.500Z",
"msisdn": "+4912984900817",
"country": "DE",
"is_primary": true,
"porting_opt_in": {"enabled": true,
"expires_at": "2025-01-03T00:00:00.500Z"
},
"_links": {"self": {"href": "https://api.1global.com/connect/phone-numbers/pn_01BX5ZZKBKACTAV9WEVGEMUIJ6"
},
"disable-porting-opt-in": {"href": "https://api.1global.com/connect/phone-numbers/pn_01BX5ZZKBKACTAV9WEVGEMUIJ6/disable-porting-opt-in"
},
"subscription": {"href": "https://api.1global.com/connect/subscriptions/subs_02BX5ZZKBKACTAV9WEVGEMMVZS"
}
}
}

Disable Phone Number Opt In

Disables the Phone Number porting Opt In

Authorizations:

oAuth2

path Parameters

phone-number-id

required

string (PhoneNumberId) <= 100 characters

Example: pn_01BX5ZZKBKACTAV9WEVGEMMVL6

A string that uniquely identifies a Phone Number

header Parameters

Correlation-Id	string An unique identifier provided by the client that allows the request to be traced through the system.
Api-Version	string (ApiVersion) Value: "2025-01-28" This header is used to specify the version of the API being requested. If not specied, the latest version would be used.

Responses

Response samples

Content type

application/hal+json

{"id": "pn_01BX5ZZKBKACTAV9WEVGEMUIJ6",
"status": "active",
"created_at": "2024-01-01T00:00:00.100Z",
"updated_at": "2024-05-21T00:00:00.500Z",
"msisdn": "+4912984900817",
"country": "DE",
"is_primary": true,
"porting_opt_in": {"enabled": false
},
"_links": {"self": {"href": "https://api.1global.com/connect/phone-numbers/pn_01BX5ZZKBKACTAV9WEVGEMUIJ6"
},
"enable-porting-opt-in": {"href": "https://api.1global.com/connect/phone-numbers/pn_01BX5ZZKBKACTAV9WEVGEMUIJ6/enable-porting-opt-in"
},
"subscription": {"href": "https://api.1global.com/connect/subscriptions/subs_02BX5ZZKBKACTAV9WEVGEMMVZS"
}
}
}

Portings

Portings represent portability requests for port-in and port-out of phone numbers

List all Portings

Returns a list of Portings

Authorizations:

oAuth2

query Parameters

limit	integer <int32> (Limit) [ 1 .. 40 ] Default: 10 The page size filter
cursor	string (Cursor) A base64 encoded string that uniquely identifies the first entry of a query result.
status	string (PortingStatus) Enum: "draft" "pending" "rejected" "scheduled" "processing" "cancelation_requested" "canceled" "completed" Example: status=completed The Porting status
phone-number-id	string (PhoneNumberId) <= 100 characters Example: phone-number-id=pn_01BX5ZZKBKACTAV9WEVGEMMVL6 A string that uniquely identifies a Phone Number
subscription-id	string (SubscriptionId) <= 100 characters Example: subscription-id=subs_01J9XJ11WTYFWFH5JD2YM1S18S A string that uniquely identifies a Subscription

header Parameters

Correlation-Id	string An unique identifier provided by the client that allows the request to be traced through the system.
Api-Version	string (ApiVersion) Value: "2025-01-28" This header is used to specify the version of the API being requested. If not specied, the latest version would be used.

Responses

Response samples

Content type

application/hal+json

{"_embedded": {"portings": [{"id": "port_01HV3KWPNRCT870WV3XG41CAT3",
"direction": "in",
"preferred_schedule": {"type": "first_available_date",
"preferred_porting_at": "2024-10-01T14:28:17.456Z"
},
"country": "DE",
"status": "draft",
"msisdn": "+447559451000017",
"donor_details": {"_embedded": {"network_operator": {"id": "string",
"name": "string",
"status": "active",
"trade_name": "string",
"country": "DE",
"created_at": "2024-10-01T14:28:17.456Z",
"updated_at": "2024-10-01T14:28:17.456Z",
"_links": {"self": {"href": "http://example.com"
}
}
},
"service_provider": {"id": "string",
"name": "string",
"status": "active",
"country": "DE",
"created_at": "2024-10-01T14:28:17.456Z",
"updated_at": "2024-10-01T14:28:17.456Z",
"_links": {"self": {"href": "http://example.com"
}
}
}
},
"account": {"type": "personal"
}
},
"created_at": "2024-10-01T14:28:17.456Z",
"updated_at": "2024-10-01T14:28:17.456Z",
"_links": {"self": {"href": "http://example.com"
},
"account": {"href": "http://example.com"
},
"subscriber": {"href": "http://example.com"
},
"subscription": {"href": "http://example.com"
},
"phone_number": {"href": "http://example.com"
}
}
}
]
},
"_links": {"self": {"href": "http://example.com"
},
"next": {"href": "http://example.com"
},
"prev": {"href": "http://example.com"
}
}
}

Create a porting

Create a new porting request

Authorizations:

oAuth2

header Parameters

Correlation-Id	string An unique identifier provided by the client that allows the request to be traced through the system.
Api-Version	string (ApiVersion) Value: "2025-01-28" This header is used to specify the version of the API being requested. If not specied, the latest version would be used.

Request Body schema: application/json
required

direction required	string (CreatePortingStatus) Value: "in" Porting direction
country required	string Value: "DE" Porting country
subscription_id required	string (SubscriptionId) <= 100 characters A string that uniquely identifies a Subscription
phone_number_id required	string (PhoneNumberId) <= 100 characters A string that uniquely identifies a Phone Number
msisdn required	string (Msisdn) <= 15 characters The MSISDN of the Phone Number in E.164 format
required	object (DonorDetails)
required	object (CreatePortingPreferredSchedule)

Responses

Request samples

Payload

Content type

application/json

{"direction": "in",
"country": "DE",
"subscription_id": "subs_01J9XJ11WTYFWFH5JD2YM1S18S",
"phone_number_id": "pn_01BX5ZZKBKACTAV9WEVGEMMVL6",
"msisdn": "+447559451000017",
"donor_details": {"network_operator_id": "nopr_01HV3KWPNRCT870WV3XG41CAT3",
"service_provider_id": "spro_01HV3KWPNRCT870WV3XG41CAT3",
"account": {"type": "personal"
}
},
"preferred_schedule": {"type": "specific_date",
"preferred_porting_at": "2024-10-01T14:28:17.456Z"
}
}

Response samples

Content type

application/hal+json

{"id": "port_01J6HE2DP5M8GKQ9P8R83VQW3J",
"direction": "in",
"preferred_schedule": {"type": "first_available_date",
"preferred_porting_at": "2024-08-30T10:42:34.309Z"
},
"country": "DE",
"status": "draft",
"msisdn": "+4912341234123",
"donor_details": {"_embedded": {"network_operator": {"id": "nopr_01J6795M195EXEECTPY9Y3QD66",
"name": "Operator Name",
"trade_name": "Trade Operator Name",
"country": "DE",
"status": "active",
"created_at": "2024-08-30T10:42:34.309Z",
"updated_at": "2024-08-30T10:42:34.309Z",
"_links": {"self": {"href": "https://api.1global.com/connect/network-operators/nopr_01J6795M195EXEECTPY9Y3QD66"
}
}
},
"service_provider": {"id": "spro_01J6795M195EXEECTPY9Y3QD66",
"name": "Provider Name",
"country": "DE",
"status": "active",
"created_at": "2024-08-30T10:42:34.309Z",
"updated_at": "2024-08-30T10:42:34.309Z",
"_links": {"self": {"href": "https://api.1global.com/connect/service-providers/spro_01J6795M195EXEECTPY9Y3QD66"
}
}
}
},
"account": {"type": "personal"
}
},
"created_at": "2024-08-30T10:42:34.309Z",
"updated_at": "2024-08-30T10:42:34.309Z",
"_links": {"self": {"href": "https://api.1global.com/connect/portings/port_01J6HE2DP5M8GKQ9P8R83VQW3J"
},
"account": {"href": "https://api.1global.com/connect/acounts/acc_01J6795M195EXEECTPY9Y3QD66"
},
"subscriber": {"href": "https://api.1global.com/connect/subscriber/subr_01J67F1GGCN0ZMGJQ17NTYV3WV"
},
"subscription": {"href": "https://api.1global.com/connect/subscriptions/subs_01J67SMMCM050XM1C1ABQNFD9K"
},
"phone_number": {"href": "https://api.1global.com/connect/phone-numbers/pn_01J6795M195EXEECTPY9Y3QD66"
}
}
}

Retrieve a porting

Retrieves a porting

Authorizations:

oAuth2

path Parameters

porting-id

required

string (PortingId) <= 100 characters

Example: port_01HV3KWPNRCT870WV3XG41CAT3

The resource identifier.

header Parameters

Correlation-Id	string An unique identifier provided by the client that allows the request to be traced through the system.
Api-Version	string (ApiVersion) Value: "2025-01-28" This header is used to specify the version of the API being requested. If not specied, the latest version would be used.

Responses

Response samples

Content type

application/hal+json

Example

Pending Port-Out

{"id": "port_01J6HE2DP5M8GKQ9P8R83VQW3J",
"direction": "out",
"termination_action": "terminate",
"preferred_schedule": {"type": "first_available_date",
"preferred_porting_at": "2024-08-30T10:42:34.309Z"
},
"country": "DE",
"status": "pending",
"recipient_details": {"_embedded": {"network_operator": {"id": "nopr_01J6795M195EXEECTPY9Y3QD66",
"name": "Operator Name",
"trade_name": "Trade Operator Name",
"country": "DE",
"status": "active",
"created_at": "2024-08-30T10:42:34.309Z",
"updated_at": "2024-08-30T10:42:34.309Z",
"_links": {"self": {"href": "https://api.1global.com/connect/network-operators/nopr_01J6795M195EXEECTPY9Y3QD66"
}
}
},
"service_provider": {"id": "spro_01J6795M195EXEECTPY9Y3QD66",
"name": "Provider Name",
"country": "DE",
"status": "active",
"created_at": "2024-08-30T10:42:34.309Z",
"updated_at": "2024-08-30T10:42:34.309Z",
"_links": {"self": {"href": "https://api.1global.com/connect/service-providers/spro_01J6795M195EXEECTPY9Y3QD66"
}
}
}
}
},
"created_at": "2024-08-30T10:42:34.309Z",
"updated_at": "2024-08-30T10:42:34.309Z",
"_links": {"self": {"href": "https://api.1global.com/connect/portings/port_01J6HE2DP5M8GKQ9P8R83VQW3J"
},
"account": {"href": "https://api.1global.com/connect/acounts/acc_01J6795M195EXEECTPY9Y3QD66"
},
"subscriber": {"href": "https://api.1global.com/connect/subscriber/subr_01J67F1GGCN0ZMGJQ17NTYV3WV"
},
"subscription": {"href": "https://api.1global.com/connect/subscriptions/subs_01J67SMMCM050XM1C1ABQNFD9K"
},
"phone_number": {"href": "https://api.1global.com/connect/phone-numbers/pn_01J6795M195EXEECTPY9Y3QD66"
}
}
}

Accept a porting request

Authorizations:

oAuth2

path Parameters

porting-id

required

string (PortingId) <= 100 characters

Example: port_01HV3KWPNRCT870WV3XG41CAT3

The resource identifier.

header Parameters

Correlation-Id	string An unique identifier provided by the client that allows the request to be traced through the system.
Api-Version	string (ApiVersion) Value: "2025-01-28" This header is used to specify the version of the API being requested. If not specied, the latest version would be used.

Request Body schema: application/json
required

termination_action

string

Value: "terminate"

The termination action when porting out the number

Responses

Request samples

Payload

Content type

application/json

{"termination_action": "terminate"
}

Response samples

Content type

application/hal+json

Example

PortingInDraftOrPending

{"id": "port_01HV3KWPNRCT870WV3XG41CAT3",
"direction": "in",
"preferred_schedule": {"type": "first_available_date",
"preferred_porting_at": "2024-10-01T14:28:17.456Z"
},
"country": "DE",
"status": "draft",
"msisdn": "+447559451000017",
"donor_details": {"_embedded": {"network_operator": {"id": "string",
"name": "string",
"status": "active",
"trade_name": "string",
"country": "DE",
"created_at": "2024-10-01T14:28:17.456Z",
"updated_at": "2024-10-01T14:28:17.456Z",
"_links": {"self": {"href": "http://example.com"
}
}
},
"service_provider": {"id": "string",
"name": "string",
"status": "active",
"country": "DE",
"created_at": "2024-10-01T14:28:17.456Z",
"updated_at": "2024-10-01T14:28:17.456Z",
"_links": {"self": {"href": "http://example.com"
}
}
}
},
"account": {"type": "personal"
}
},
"created_at": "2024-10-01T14:28:17.456Z",
"updated_at": "2024-10-01T14:28:17.456Z",
"_links": {"self": {"href": "http://example.com"
},
"account": {"href": "http://example.com"
},
"subscriber": {"href": "http://example.com"
},
"subscription": {"href": "http://example.com"
},
"phone_number": {"href": "http://example.com"
}
}
}

Rejects a porting request

Authorizations:

oAuth2

path Parameters

porting-id

required

string (PortingId) <= 100 characters

Example: port_01HV3KWPNRCT870WV3XG41CAT3

The resource identifier.

header Parameters

Correlation-Id	string An unique identifier provided by the client that allows the request to be traced through the system.
Api-Version	string (ApiVersion) Value: "2025-01-28" This header is used to specify the version of the API being requested. If not specied, the latest version would be used.

Request Body schema: application/json
required

reason	string Value: "pre_requirements_not_fulfilled" The rejection reason code
message	string Additional message explaining the rejection

Responses

Request samples

Payload

Content type

application/json

{"reason": "pre_requirements_not_fulfilled",
"message": "string"
}

Response samples

Content type

application/hal+json

Example

PortingInDraftOrPending

{"id": "port_01HV3KWPNRCT870WV3XG41CAT3",
"direction": "in",
"preferred_schedule": {"type": "first_available_date",
"preferred_porting_at": "2024-10-01T14:28:17.456Z"
},
"country": "DE",
"status": "draft",
"msisdn": "+447559451000017",
"donor_details": {"_embedded": {"network_operator": {"id": "string",
"name": "string",
"status": "active",
"trade_name": "string",
"country": "DE",
"created_at": "2024-10-01T14:28:17.456Z",
"updated_at": "2024-10-01T14:28:17.456Z",
"_links": {"self": {"href": "http://example.com"
}
}
},
"service_provider": {"id": "string",
"name": "string",
"status": "active",
"country": "DE",
"created_at": "2024-10-01T14:28:17.456Z",
"updated_at": "2024-10-01T14:28:17.456Z",
"_links": {"self": {"href": "http://example.com"
}
}
}
},
"account": {"type": "personal"
}
},
"created_at": "2024-10-01T14:28:17.456Z",
"updated_at": "2024-10-01T14:28:17.456Z",
"_links": {"self": {"href": "http://example.com"
},
"account": {"href": "http://example.com"
},
"subscriber": {"href": "http://example.com"
},
"subscription": {"href": "http://example.com"
},
"phone_number": {"href": "http://example.com"
}
}
}

Request cancelation of the porting

Authorizations:

oAuth2

path Parameters

porting-id

required

string (PortingId) <= 100 characters

Example: port_01HV3KWPNRCT870WV3XG41CAT3

The resource identifier.

header Parameters

Correlation-Id	string An unique identifier provided by the client that allows the request to be traced through the system.
Api-Version	string (ApiVersion) Value: "2025-01-28" This header is used to specify the version of the API being requested. If not specied, the latest version would be used.

Request Body schema: application/json
required

reason required	string Value: "user_requested" The request cancelation reason
message	string

Responses

Request samples

Payload

Content type

application/json

{"reason": "user_requested",
"message": "string"
}

Response samples

Content type

application/hal+json

{"id": "port_01J6HE2DP5M8GKQ9P8R83VQW3J",
"direction": "in",
"preferred_schedule": {"type": "first_available_date",
"preferred_porting_at": "2024-08-30T10:42:34.309Z"
},
"country": "DE",
"status": "cancelation_requested",
"msisdn": "+4912341234123",
"donor_details": {"_embedded": {"network_operator": {"id": "nopr_01J6795M195EXEECTPY9Y3QD66",
"name": "Operator Name",
"trade_name": "Trade Operator Name",
"country": "DE",
"status": "active",
"created_at": "2024-08-30T10:42:34.309Z",
"updated_at": "2024-08-30T10:42:34.309Z",
"_links": {"self": {"href": "https://api.1global.com/connect/network-operators/nopr_01J6795M195EXEECTPY9Y3QD66"
}
}
},
"service_provider": {"id": "spro_01J6795M195EXEECTPY9Y3QD66",
"name": "Provider Name",
"country": "DE",
"status": "active",
"created_at": "2024-08-30T10:42:34.309Z",
"updated_at": "2024-08-30T10:42:34.309Z",
"_links": {"self": {"href": "https://api.1global.com/connect/service-providers/spro_01J6795M195EXEECTPY9Y3QD66"
}
}
}
},
"account": {"type": "personal"
}
},
"cancelation_deadline_at": "2024-10-01T14:28:17.456Z",
"scheduled_at": "2024-10-01T14:28:17.456Z",
"created_at": "2024-08-30T10:42:34.309Z",
"updated_at": "2024-08-30T10:42:34.309Z",
"_links": {"self": {"href": "https://api.1global.com/connect/portings/port_01J6HE2DP5M8GKQ9P8R83VQW3J"
},
"account": {"href": "https://api.1global.com/connect/acounts/acc_01J6795M195EXEECTPY9Y3QD66"
},
"subscriber": {"href": "https://api.1global.com/connect/subscriber/subr_01J67F1GGCN0ZMGJQ17NTYV3WV"
},
"subscription": {"href": "https://api.1global.com/connect/subscriptions/subs_01J67SMMCM050XM1C1ABQNFD9K"
},
"phone_number": {"href": "https://api.1global.com/connect/phone-numbers/pn_01J6795M195EXEECTPY9Y3QD66"
}
}
}

Accept a porting cancelation request

Accepts a porting cancelation request

Authorizations:

oAuth2

path Parameters

porting-id

required

string (PortingId) <= 100 characters

Example: port_01HV3KWPNRCT870WV3XG41CAT3

The resource identifier.

header Parameters

Correlation-Id	string An unique identifier provided by the client that allows the request to be traced through the system.
Api-Version	string (ApiVersion) Value: "2025-01-28" This header is used to specify the version of the API being requested. If not specied, the latest version would be used.

Request Body schema: application/json
required

message

string

Responses

Request samples

Payload

Content type

application/json

{"message": "string"
}

Response samples

Content type

application/hal+json

Example

PortingInDraftOrPending

{"id": "port_01HV3KWPNRCT870WV3XG41CAT3",
"direction": "in",
"preferred_schedule": {"type": "first_available_date",
"preferred_porting_at": "2024-10-01T14:28:17.456Z"
},
"country": "DE",
"status": "draft",
"msisdn": "+447559451000017",
"donor_details": {"_embedded": {"network_operator": {"id": "string",
"name": "string",
"status": "active",
"trade_name": "string",
"country": "DE",
"created_at": "2024-10-01T14:28:17.456Z",
"updated_at": "2024-10-01T14:28:17.456Z",
"_links": {"self": {"href": "http://example.com"
}
}
},
"service_provider": {"id": "string",
"name": "string",
"status": "active",
"country": "DE",
"created_at": "2024-10-01T14:28:17.456Z",
"updated_at": "2024-10-01T14:28:17.456Z",
"_links": {"self": {"href": "http://example.com"
}
}
}
},
"account": {"type": "personal"
}
},
"created_at": "2024-10-01T14:28:17.456Z",
"updated_at": "2024-10-01T14:28:17.456Z",
"_links": {"self": {"href": "http://example.com"
},
"account": {"href": "http://example.com"
},
"subscriber": {"href": "http://example.com"
},
"subscription": {"href": "http://example.com"
},
"phone_number": {"href": "http://example.com"
}
}
}

Rejects a porting cancelation request

Authorizations:

oAuth2

path Parameters

porting-id

required

string (PortingId) <= 100 characters

Example: port_01HV3KWPNRCT870WV3XG41CAT3

The resource identifier.

header Parameters

Correlation-Id	string An unique identifier provided by the client that allows the request to be traced through the system.
Api-Version	string (ApiVersion) Value: "2025-01-28" This header is used to specify the version of the API being requested. If not specied, the latest version would be used.

Request Body schema: application/json
required

reason	string Value: "cancelation_too_late" The reject cancelation reason
message	string

Responses

Request samples

Payload

Content type

application/json

{"reason": "cancelation_too_late",
"message": "string"
}

Response samples

Content type

application/hal+json

Example

PortingInDraftOrPending

{"id": "port_01HV3KWPNRCT870WV3XG41CAT3",
"direction": "in",
"preferred_schedule": {"type": "first_available_date",
"preferred_porting_at": "2024-10-01T14:28:17.456Z"
},
"country": "DE",
"status": "draft",
"msisdn": "+447559451000017",
"donor_details": {"_embedded": {"network_operator": {"id": "string",
"name": "string",
"status": "active",
"trade_name": "string",
"country": "DE",
"created_at": "2024-10-01T14:28:17.456Z",
"updated_at": "2024-10-01T14:28:17.456Z",
"_links": {"self": {"href": "http://example.com"
}
}
},
"service_provider": {"id": "string",
"name": "string",
"status": "active",
"country": "DE",
"created_at": "2024-10-01T14:28:17.456Z",
"updated_at": "2024-10-01T14:28:17.456Z",
"_links": {"self": {"href": "http://example.com"
}
}
}
},
"account": {"type": "personal"
}
},
"created_at": "2024-10-01T14:28:17.456Z",
"updated_at": "2024-10-01T14:28:17.456Z",
"_links": {"self": {"href": "http://example.com"
},
"account": {"href": "http://example.com"
},
"subscriber": {"href": "http://example.com"
},
"subscription": {"href": "http://example.com"
},
"phone_number": {"href": "http://example.com"
}
}
}

Product Catalogs

Product Catalogs aggregate a group of Product Offerings

List all Product Catalogs

Returns a list of product catalogs

Authorizations:

oAuth2

query Parameters

cursor	string (Cursor) A base64 encoded string that uniquely identifies the first entry of a query result.
limit	integer <int32> (Limit) [ 1 .. 40 ] Default: 10 The page size filter
name	string The product catalog name

header Parameters

Correlation-Id	string An unique identifier provided by the client that allows the request to be traced through the system.
Api-Version	string (ApiVersion) Value: "2025-01-28" This header is used to specify the version of the API being requested. If not specied, the latest version would be used.

Responses

Response samples

Content type

application/hal+json

Example

Example with one product catalog

{"_embedded": {"product_catalogs": [{"id": "prdcat_92BX5ZZKBKGCTAV9WEVGEMMVRY",
"name": "Generic Product Catalog",
"created_at": "2021-03-01T14:28:17.967Z",
"updated_at": "2022-03-01T16:23:10.445Z",
"_links": {"self": {"href": "https://api.1global.com/connect/product-catalogs/prdcat_92BX5ZZKBKGCTAV9WEVGEMMVRY"
},
"product-offerings": {"href": "https://api.1global.com/connect/product-catalogs/prdcat_92BX5ZZKBKGCTAV9WEVGEMMVRY/product-offerings"
}
}
}
]
},
"_links": {"self": {"href": "https://api.1global.com/connect/product-catalogs"
},
"next": {"href": "https://api.1global.com/connect/product-catalogs?cursor=nextCursor&limit=10"
},
"prev": {"href": "https://api.1global.com/connect/product-catalogs?cursor=prevCursor&limit=10"
}
}
}

Retrieve a Product Catalog

Retrieves the details of a product catalog

Authorizations:

oAuth2

path Parameters

product-catalog-id

required

string (ProductCatalogId) <= 100 characters

Example: prdcat_01BX5ZZKBKACTAV9WEVGEMMVRY

An identifier of the product catalog.

header Parameters

Correlation-Id	string An unique identifier provided by the client that allows the request to be traced through the system.
Api-Version	string (ApiVersion) Value: "2025-01-28" This header is used to specify the version of the API being requested. If not specied, the latest version would be used.

Responses

Response samples

Content type

application/hal+json

{"id": "prdcat_01BX5ZZKBKACTAV9WEVGEMMVRY",
"name": "Global Product Catalog",
"created_at": "2021-02-01T14:28:17.967Z",
"updated_at": "2022-02-05T08:23:14.345Z",
"_links": {"self": {"href": "https://api.1global.com/connect/product-catalogs/prdcat_01BX5ZZKBKACTAV9WEVGEMMVRY"
},
"product-offerings": {"href": "https://api.1global.com/connect/product-catalogs/prdcat_01BX5ZZKBKACTAV9WEVGEMMVRY/product-offerings"
}
}
}

List all Product Offerings of a Product Catalog

Returns a list of product offerings from a specific product catalog

Authorizations:

oAuth2

path Parameters

product-catalog-id

required

string (ProductCatalogId) <= 100 characters

Example: prdcat_01BX5ZZKBKACTAV9WEVGEMMVRY

An identifier of the product catalog.

query Parameters

status	string (ProductOfferingStatus) Enum: "active" "inactive" The Product Offering status
type	string (ProductOfferingType) Enum: "plan" "addon" The Product Offering type
allowances[coverage-area][countries]	string (AllowancesCountries) Example: allowances[coverage-area][countries]=GB,FR The Allowance Countries.
cursor	string (Cursor) A base64 encoded string that uniquely identifies the first entry of a query result.
limit	integer <int32> (Limit) [ 1 .. 40 ] Default: 10 The page size filter

header Parameters

Correlation-Id	string An unique identifier provided by the client that allows the request to be traced through the system.
Api-Version	string (ApiVersion) Value: "2025-01-28" This header is used to specify the version of the API being requested. If not specied, the latest version would be used.

Responses

Response samples

Content type

application/hal+json

{"_embedded": {"product_offerings": [{"id": "prdoff_01J83E2WMQBDBEK70SX0N5RJ1P",
"name": "Local Portugal - 1 Day",
"created_at": "2024-09-18T20:44:51.223Z",
"updated_at": "2024-09-18T21:50:51.233Z",
"status": "active",
"type": "addon",
"availability": {"start_at": "2024-09-18T19:59:56.000Z",
"end_at": "2025-09-18T19:59:56.000Z"
},
"validity": {"type": "duration",
"unit": "month",
"unit_count": 1,
"is_recurrent": false
},
"_embedded": {"allowances": [{"type": "data",
"unit": "gigabytes",
"unit_count": 100,
"is_unlimited": false,
"_embedded": {"coverage_area": {"id": "cov_01J83E2VNKR4GD78MF1R43YWTK",
"name": "Portugal",
"type": "local",
"created_at": "2024-09-18T20:44:50.227Z",
"updated_at": "2024-09-18T20:44:50.227Z",
"countries": ["PT"
],
"_links": {"self": {"href": "https://api.1global.com/connect/coverage-areas/cov_01J83E2VNKR4GD78MF1R43YWTK"
}
}
}
}
}
],
"prices": [{"type": "recurring",
"unit_amount": 50,
"currency": "EUR",
"recurrence": {"unit": "month",
"unit_count": 3
}
}
]
},
"_links": {"self": {"href": "https://api.1global.com/connect/product-offerings/prdoff_01J83E2WMQBDBEK70SX0N5RJ1P"
}
}
},
{"id": "prdoff_01J83E2WMQBDBEK70SX0N5R4GL",
"name": "Local Spain - 1 Day",
"created_at": "2024-09-18T20:44:51.223Z",
"updated_at": "2024-09-24T08:00:34.123Z",
"status": "active",
"type": "addon",
"availability": {"start_at": "2024-09-18T19:59:56.000Z",
"end_at": "2025-09-18T19:59:56.000Z"
},
"validity": {"type": "duration",
"unit": "month",
"unit_count": 1,
"is_recurrent": false
},
"_embedded": {"allowances": [{"type": "data",
"unit": "gigabytes",
"unit_count": 80,
"is_unlimited": false,
"_embedded": {"coverage_area": {"id": "cov_01J83E2VNKR4GD78MF1R43YIW3",
"name": "Spain",
"type": "local",
"created_at": "2024-01-14T20:44:50.098Z",
"countries": ["ES"
],
"_links": {"self": {"href": "https://api.1global.com/connect/coverage-areas/cov_01J83E2VNKR4GD78MF1R43YIW3"
}
}
}
}
}
],
"prices": [{"type": "one_time",
"unit_amount": 100,
"currency": "EUR"
}
]
},
"_links": {"self": {"href": "https://api.1global.com/connect/product-offerings/prdoff_01J83E2WMQBDBEK70SX0N5R4GL"
}
}
}
]
},
"_links": {"self": {"href": "https://api.1global.com/connect/product-offerings?limit=2"
},
"prev": {"href": "https://api.1global.com/connect/product-offerings?cursor=eyJzbyI6eyJkIjoiREVTQyIsInAiOiJleHRlcm5hbElkIn0sInNpZCI6bnVsbCwicyI6bnVsbCwidCI6Ik5FWFQiLCJpZCI6InN1YnNfMDFKQTVESzdEOFBEQ0hTSDI3RjMzUjVXNDYifQ==&limit=2"
},
"next": {"href": "https://api.1global.com/connect/product-offerings?cursor=eyJzbyI6eyJkIjoiREVTQyIsInAiOiJleHRlcm5hbElkIn0sInNpZCI6bnVsbCwicyI6bnVsbCwidCI6Ik5FWFQiLCJpZCI6InN1YnNfMDFKQTVESzdEOFBEQ0hTSDI3RjMzUjVXNDYifQ==&limit=2"
}
}
}

Product Offerings

Product Offerings are blueprints for Products. You can access your Product Offerings via a single request. Lists all product offerings endpoint will show you the complete list of products and their respective Ids, which can be used in an order to activate/topup eSIM profiles.

Lists all Product Offerings

Returns a list of product offerings

Authorizations:

oAuth2

query Parameters

status	string (ProductOfferingStatus) Enum: "active" "inactive" The Product Offering status
type	string (ProductOfferingType) Enum: "plan" "addon" The Product Offering type
allowances[coverage-area][countries]	string (AllowancesCountries) Example: allowances[coverage-area][countries]=GB,FR The Allowance Countries.
cursor	string (Cursor) A base64 encoded string that uniquely identifies the first entry of a query result.
limit	integer <int32> (Limit) [ 1 .. 40 ] Default: 10 The page size filter

header Parameters

Correlation-Id	string An unique identifier provided by the client that allows the request to be traced through the system.
Api-Version	string (ApiVersion) Value: "2025-01-28" This header is used to specify the version of the API being requested. If not specied, the latest version would be used.

Responses

Response samples

Content type

application/hal+json

{"_embedded": {"product_offerings": [{"id": "prdoff_01J83E2WMQBDBEK70SX0N5RJ1P",
"name": "Local Portugal - 1 Day",
"created_at": "2024-09-18T20:44:51.223Z",
"updated_at": "2024-09-18T21:50:51.233Z",
"status": "active",
"type": "addon",
"availability": {"start_at": "2024-09-18T19:59:56.000Z",
"end_at": "2025-09-18T19:59:56.000Z"
},
"validity": {"type": "duration",
"unit": "month",
"unit_count": 1,
"is_recurrent": false
},
"_embedded": {"allowances": [{"type": "data",
"unit": "gigabytes",
"unit_count": 100,
"is_unlimited": false,
"_embedded": {"coverage_area": {"id": "cov_01J83E2VNKR4GD78MF1R43YWTK",
"name": "Portugal",
"type": "local",
"created_at": "2024-09-18T20:44:50.227Z",
"updated_at": "2024-09-18T20:44:50.227Z",
"countries": ["PT"
],
"_links": {"self": {"href": "https://api.1global.com/connect/coverage-areas/cov_01J83E2VNKR4GD78MF1R43YWTK"
}
}
}
}
}
],
"prices": [{"type": "recurring",
"unit_amount": 50,
"currency": "EUR",
"recurrence": {"unit": "month",
"unit_count": 3
}
}
]
},
"_links": {"self": {"href": "https://api.1global.com/connect/product-offerings/prdoff_01J83E2WMQBDBEK70SX0N5RJ1P"
}
}
},
{"id": "prdoff_01J83E2WMQBDBEK70SX0N5R4GL",
"name": "Local Spain - 1 Day",
"created_at": "2024-09-18T20:44:51.223Z",
"updated_at": "2024-09-24T08:00:34.123Z",
"status": "active",
"type": "addon",
"availability": {"start_at": "2024-09-18T19:59:56.000Z",
"end_at": "2025-09-18T19:59:56.000Z"
},
"validity": {"type": "duration",
"unit": "month",
"unit_count": 1,
"is_recurrent": false
},
"_embedded": {"allowances": [{"type": "data",
"unit": "gigabytes",
"unit_count": 80,
"is_unlimited": false,
"_embedded": {"coverage_area": {"id": "cov_01J83E2VNKR4GD78MF1R43YIW3",
"name": "Spain",
"type": "local",
"created_at": "2024-01-14T20:44:50.098Z",
"countries": ["ES"
],
"_links": {"self": {"href": "https://api.1global.com/connect/coverage-areas/cov_01J83E2VNKR4GD78MF1R43YIW3"
}
}
}
}
}
],
"prices": [{"type": "one_time",
"unit_amount": 100,
"currency": "EUR"
}
]
},
"_links": {"self": {"href": "https://api.1global.com/connect/product-offerings/prdoff_01J83E2WMQBDBEK70SX0N5R4GL"
}
}
}
]
},
"_links": {"self": {"href": "https://api.1global.com/connect/product-offerings?limit=2"
},
"prev": {"href": "https://api.1global.com/connect/product-offerings?cursor=eyJzbyI6eyJkIjoiREVTQyIsInAiOiJleHRlcm5hbElkIn0sInNpZCI6bnVsbCwicyI6bnVsbCwidCI6Ik5FWFQiLCJpZCI6InN1YnNfMDFKQTVESzdEOFBEQ0hTSDI3RjMzUjVXNDYifQ==&limit=2"
},
"next": {"href": "https://api.1global.com/connect/product-offerings?cursor=eyJzbyI6eyJkIjoiREVTQyIsInAiOiJleHRlcm5hbElkIn0sInNpZCI6bnVsbCwicyI6bnVsbCwidCI6Ik5FWFQiLCJpZCI6InN1YnNfMDFKQTVESzdEOFBEQ0hTSDI3RjMzUjVXNDYifQ==&limit=2"
}
}
}

Retrieve a Product Offering

Retrieves the details of an existing product offering

Authorizations:

oAuth2

path Parameters

product-offering-id

required

string (ProductOfferingId) <= 100 characters

Example: prdoff_01HV483CD6YFTW68D18V23Y8NJ

An identifier of the product offering.

header Parameters

Correlation-Id	string An unique identifier provided by the client that allows the request to be traced through the system.
Api-Version	string (ApiVersion) Value: "2025-01-28" This header is used to specify the version of the API being requested. If not specied, the latest version would be used.

Responses

Response samples

Content type

application/hal+json

Example

Product Offering

{"id": "prdoff_01J83E2WMQBDBEK70SX0N5RJ1P",
"name": "Addon - Local Portugal - 1 Day",
"created_at": "2024-09-18T20:44:51.223Z",
"updated_at": "2024-09-18T21:34:02.456Z",
"status": "active",
"type": "addon",
"availability": {"start_at": "2024-09-18T19:59:56.000Z",
"end_at": "2025-09-18T19:59:56.000Z"
},
"validity": {"type": "duration",
"unit": "day",
"unit_count": 1,
"is_recurrent": false
},
"_embedded": {"allowances": [{"type": "data",
"unit": "gigabytes",
"unit_count": 70,
"is_unlimited": false,
"_embedded": {"coverage_area": {"id": "cov_01J83E2VNKR4GD78MF1R43YWTK",
"name": "Portugal",
"type": "local",
"created_at": "2024-09-18T20:44:50.227Z",
"updated_at": "2024-09-18T21:23:10.000Z",
"countries": ["PT"
],
"_links": {"self": {"href": "https://api.1global.com/connect/coverage-areas/cov_01J83E2VNKR4GD78MF1R43YWTK"
}
}
}
}
}
],
"prices": [{"type": "one_time",
"unit_amount": 100,
"currency": "EUR"
}
]
},
"_links": {"self": {"href": "https://api.1global.com/connect/product-offerings/prdoff_01J83E2WMQBDBEK70SX0N5RJ1P"
}
}
}

Lists all compatible Product Offerings

Returns a list of product offerings compatible with this one

Authorizations:

oAuth2

path Parameters

product-offering-id

required

string (ProductOfferingId) <= 100 characters

Example: prdoff_01HV483CD6YFTW68D18V23Y8NJ

An identifier of the product offering.

query Parameters

cursor	string (Cursor) A base64 encoded string that uniquely identifies the first entry of a query result.
limit	integer <int32> (Limit) [ 1 .. 40 ] Default: 10 The page size filter

header Parameters

Correlation-Id	string An unique identifier provided by the client that allows the request to be traced through the system.
Api-Version	string (ApiVersion) Value: "2025-01-28" This header is used to specify the version of the API being requested. If not specied, the latest version would be used.

Responses

Response samples

Content type

application/hal+json

{"_embedded": {"product_offerings": [{"id": "prdoff_01J83E2WMQBDBEK70SX0N5RJ1P",
"name": "Local Portugal - 1 Day",
"created_at": "2024-09-18T20:44:51.223Z",
"updated_at": "2024-09-18T21:50:51.233Z",
"status": "active",
"type": "addon",
"availability": {"start_at": "2024-09-18T19:59:56.000Z",
"end_at": "2025-09-18T19:59:56.000Z"
},
"validity": {"type": "duration",
"unit": "month",
"unit_count": 1,
"is_recurrent": false
},
"_embedded": {"allowances": [{"type": "data",
"unit": "gigabytes",
"unit_count": 100,
"is_unlimited": false,
"_embedded": {"coverage_area": {"id": "cov_01J83E2VNKR4GD78MF1R43YWTK",
"name": "Portugal",
"type": "local",
"created_at": "2024-09-18T20:44:50.227Z",
"updated_at": "2024-09-18T20:44:50.227Z",
"countries": ["PT"
],
"_links": {"self": {"href": "https://api.1global.com/connect/coverage-areas/cov_01J83E2VNKR4GD78MF1R43YWTK"
}
}
}
}
}
],
"prices": [{"type": "recurring",
"unit_amount": 50,
"currency": "EUR",
"recurrence": {"unit": "month",
"unit_count": 3
}
}
]
},
"_links": {"self": {"href": "https://api.1global.com/connect/product-offerings/prdoff_01J83E2WMQBDBEK70SX0N5RJ1P"
}
}
},
{"id": "prdoff_01J83E2WMQBDBEK70SX0N5R4GL",
"name": "Local Spain - 1 Day",
"created_at": "2024-09-18T20:44:51.223Z",
"updated_at": "2024-09-24T08:00:34.123Z",
"status": "active",
"type": "addon",
"availability": {"start_at": "2024-09-18T19:59:56.000Z",
"end_at": "2025-09-18T19:59:56.000Z"
},
"validity": {"type": "duration",
"unit": "month",
"unit_count": 1,
"is_recurrent": false
},
"_embedded": {"allowances": [{"type": "data",
"unit": "gigabytes",
"unit_count": 80,
"is_unlimited": false,
"_embedded": {"coverage_area": {"id": "cov_01J83E2VNKR4GD78MF1R43YIW3",
"name": "Spain",
"type": "local",
"created_at": "2024-01-14T20:44:50.098Z",
"countries": ["ES"
],
"_links": {"self": {"href": "https://api.1global.com/connect/coverage-areas/cov_01J83E2VNKR4GD78MF1R43YIW3"
}
}
}
}
}
],
"prices": [{"type": "one_time",
"unit_amount": 100,
"currency": "EUR"
}
]
},
"_links": {"self": {"href": "https://api.1global.com/connect/product-offerings/prdoff_01J83E2WMQBDBEK70SX0N5R4GL"
}
}
}
]
},
"_links": {"self": {"href": "https://api.1global.com/connect/product-offerings?limit=2"
},
"prev": {"href": "https://api.1global.com/connect/product-offerings?cursor=eyJzbyI6eyJkIjoiREVTQyIsInAiOiJleHRlcm5hbElkIn0sInNpZCI6bnVsbCwicyI6bnVsbCwidCI6Ik5FWFQiLCJpZCI6InN1YnNfMDFKQTVESzdEOFBEQ0hTSDI3RjMzUjVXNDYifQ==&limit=2"
},
"next": {"href": "https://api.1global.com/connect/product-offerings?cursor=eyJzbyI6eyJkIjoiREVTQyIsInAiOiJleHRlcm5hbElkIn0sInNpZCI6bnVsbCwicyI6bnVsbCwidCI6Ik5FWFQiLCJpZCI6InN1YnNfMDFKQTVESzdEOFBEQ0hTSDI3RjMzUjVXNDYifQ==&limit=2"
}
}
}

Products

A Product is an instance of the Product Offering that has been ordered & provisioned. Products are created by placing a new Order and always have a Product Offering.

List all products

Returns a list of products

Authorizations:

oAuth2

query Parameters

limit	integer <int32> (Limit) [ 1 .. 40 ] Default: 10 The page size filter
cursor	string (Cursor) A base64 encoded string that uniquely identifies the first entry of a query result.
status	string (ProductStatus) Enum: "active" "scheduled" "pending_first_usage" "expired" "terminated" "depleted" "canceled" The product status
subscription-id	string (SubscriptionId) <= 100 characters Example: subscription-id=subs_01J9XJ11WTYFWFH5JD2YM1S18S A string that uniquely identifies a Subscription
order-id	string (OrderId) <= 100 characters Example: order-id=ord_01HV3KWPNRCT870WV3XG41CAT3 An identifier of the order.

header Parameters

Correlation-Id	string An unique identifier provided by the client that allows the request to be traced through the system.
Api-Version	string (ApiVersion) Value: "2025-01-28" This header is used to specify the version of the API being requested. If not specied, the latest version would be used.

Responses

Response samples

Content type

application/hal+json

{"_embedded": {"products": [{"id": "prd_01J7ZWP2Q7C2VJRAPW5D62GQEH",
"status": "active",
"created_at": "2024-09-17T11:43:02.375Z",
"start_at": "2024-09-17T11:43:03.579Z",
"started_at": "2024-09-17T11:43:03.475Z",
"end_at": "2024-10-17T11:43:03.579Z",
"_embedded": {"product_offering": {"id": "prdoff_01J7ZWNYNYVJYKWGJR98FA3NZS",
"name": "Local Germany 1 Month 500 MB",
"type": "addon",
"validity": {"type": "duration",
"unit": "month",
"unit_count": 1,
"is_recurrent": false
},
"_embedded": {"allowances": [{"type": "data",
"unit": "megabytes",
"unit_count": 500,
"is_unlimited": false,
"_embedded": {"coverage_area": {"id": "cov_01J7ZWNXBNSHG0Q0RWERPP5QDW",
"name": "Germany",
"type": "local",
"created_at": "2024-09-17T11:42:56.875Z",
"updated_at": "2024-09-17T14:45:03.234Z",
"countries": ["DE"
],
"_links": {"self": {"href": "https://api.1global.com/connect/coverage-areas/cov_01J7ZWNXBNSHG0Q0RWERPP5QDW"
}
}
}
}
}
]
},
"_links": {"self": {"href": "https://api.1global.com/connect/product-offerings/prdoff_01J7ZWNYNYVJYKWGJR98FA3NZS"
}
}
},
"balances": [{"type": "limited",
"allowance_type": "data",
"unit": "bytes",
"initial": 524288000,
"remaining": 512154000,
"spent": 12134000
}
],
"prices": [{"type": "one_time",
"unit_amount": 1,
"currency": "EUR"
}
]
},
"_links": {"self": {"href": "https://api.1global.com/connect/products/prd_01J7ZWP2Q7C2VJRAPW5D62GQEH"
},
"order": {"href": "https://api.1global.com/connect/orders/ord_01J7ZWP1X8MBE7GZ73M75JEPB2"
},
"subscription": {"href": "https://api.1global.com/connect/subscriptions/subs_01J7ZWP28JKQAFY37GEX8XN8FS"
},
"cancel": {"href": "https://api.1global.com/connect/products/prd_01J7ZWP2Q7C2VJRAPW5D62GQEH/cancel"
}
}
},
{"id": "prd_01J82FWNGE033C2DEMCRPY1427",
"status": "canceled",
"created_at": "2024-09-18T11:57:10.029Z",
"expire_at": "2025-09-18T11:57:08.570Z",
"ended_at": "2024-09-25T12:10:40.218Z",
"_embedded": {"product_offering": {"id": "prdoff_01J8091PFJ4XWGXW5VN6T6JV3A",
"name": "Local Zimbabwe - 7 Days",
"type": "addon",
"validity": {"type": "duration",
"unit": "day",
"unit_count": 7,
"is_recurrent": false
},
"_embedded": {"allowances": [{"type": "data",
"unit": "gigabytes",
"unit_count": 1,
"is_unlimited": false,
"_embedded": {"coverage_area": {"id": "cov_01J8091P6TD2DT8R1VYEADGXSJ",
"name": "Zimbabwe",
"type": "local",
"created_at": "2024-09-17T15:19:05.690Z",
"updated_at": "2024-09-17T14:45:03.234Z",
"countries": ["ZW"
],
"_links": {"self": {"href": "https://api.1global.com/connect/coverage-areas/cov_01J8091P6TD2DT8R1VYEADGXSJ"
}
}
}
}
}
]
},
"_links": {"self": {"href": "https://api.1global.com/connect/product-offerings/prdoff_01J8091PFJ4XWGXW5VN6T6JV3A"
}
}
},
"balances": [{"type": "limited",
"allowance_type": "data",
"unit": "bytes",
"initial": 1073741824,
"remaining": 1073741824,
"spent": 0
}
],
"prices": [{"type": "one_time",
"unit_amount": 1,
"currency": "USD"
}
]
},
"_links": {"self": {"href": "https://api.1global.com/connect/products/prd_01J82FWNGE033C2DEMCRPY1427"
},
"order": {"href": "https://api.1global.com/connect/orders/ord_01J82FWM1SNAPXYHYY50XP3SMN"
},
"subscription": {"href": "https://api.1global.com/connect/subscriptions/subs_01J82FWMHCXZSAR4TMDA19Y4ZA"
}
}
}
]
},
"_links": {"self": {"href": "http://api.1global.com/connect/products?limit=2"
},
"prev": {"href": "http://api.1global.com/connect/products?cursor=eyJzbyI6eyJkIjoiREVTQyIsInAiOiJleHRlcm5hbElkIn0sInNpZCI6bnVsbCwicyI6bnVsbCwidCI6Ik5FWFQiLCJpZCI6InN1YnNfMDFKQTVESzdEOFBEQ0hTSDI3RjMzUjVXNDYifQ==&limit=20"
},
"next": {"href": "http://api.1global.com/connect/products?cursor=eyJzbyI6eyJkIjoiREVTQyIsInAiOiJleHRlcm5hbElkIn0sInNpZCI6bnVsbCwicyI6bnVsbCwidCI6Ik5FWFQiLCJpZCI6InN1YnNfMDFKQTVESzdEOFBEQ0hTSDI3RjMzUjVXNDYifQ==&limit=20"
}
}
}

Retrieve a product

Retrieves the details of an existing product

Authorizations:

oAuth2

path Parameters

product-id

required

string (ProductId) <= 100 characters

Example: prd_01BX5ZZKBKACTAV9WEVGEMMVRY

An identifier of the product.

header Parameters

Correlation-Id	string An unique identifier provided by the client that allows the request to be traced through the system.
Api-Version	string (ApiVersion) Value: "2025-01-28" This header is used to specify the version of the API being requested. If not specied, the latest version would be used.

Responses

Response samples

Content type

application/hal+json

Example

Active Product

{"id": "prd_01J7ZWP2Q7C2VJRAPW5D62GQEH",
"status": "active",
"created_at": "2024-09-17T11:43:02.023",
"start_at": "2024-09-17T11:43:03.579Z",
"started_at": "2024-09-17T11:43:04.375Z",
"end_at": "2024-10-17T11:43:01.579Z",
"_embedded": {"product_offering": {"id": "prdoff_01J7ZWNYNYVJYKWGJR98FA3NZS",
"name": "Local Germany 1 Month 500 MB",
"type": "addon",
"validity": {"type": "duration",
"unit": "month",
"unit_count": 1,
"is_recurrent": false
},
"_embedded": {"allowances": [{"type": "data",
"unit": "megabytes",
"unit_count": 500,
"is_unlimited": false,
"_embedded": {"coverage_area": {"id": "cov_01J7ZWNXBNSHG0Q0RWERPP5QDW",
"name": "Germany",
"type": "local",
"created_at": "2024-09-17T11:42:56.875Z",
"updated_at": "2024-09-17T14:45:03.234Z",
"countries": ["DE"
],
"_links": {"self": {"href": "https://api.1global.com/connect/coverage-areas/cov_01J7ZWNXBNSHG0Q0RWERPP5QDW"
}
}
}
}
}
]
},
"_links": {"self": {"href": "https://api.1global.com/connect/product-offerings/prdoff_01J7ZWNYNYVJYKWGJR98FA3NZS"
}
}
},
"balances": [{"type": "limited",
"allowance_type": "data",
"unit": "bytes",
"initial": 524288000,
"remaining": 512154000,
"spent": 12134000
}
],
"prices": [{"type": "one_time",
"unit_amount": 1,
"currency": "EUR"
}
]
},
"_links": {"self": {"href": "https://api.1global.com/connect/products/prd_01J7ZWP2Q7C2VJRAPW5D62GQEH"
},
"order": {"href": "https://api.1global.com/connect/orders/ord_01J7ZWP1X8MBE7GZ73M75JEPB2"
},
"subscription": {"href": "https://api.1global.com/connect/subscriptions/subs_01J7ZWP28JKQAFY37GEX8XN8FS"
},
"cancel": {"href": "https://api.1global.com/connect/products/prd_01J7ZWP2Q7C2VJRAPW5D62GQEH/cancel"
}
}
}

Activate a Product

Activates a product. Only products in status scheduled or pending first usage can be activated.

Authorizations:

oAuth2

path Parameters

product-id

required

string (ProductId) <= 100 characters

Example: prd_01BX5ZZKBKACTAV9WEVGEMMVRY

An identifier of the product.

header Parameters

Correlation-Id	string An unique identifier provided by the client that allows the request to be traced through the system.
Api-Version	string (ApiVersion) Value: "2025-01-28" This header is used to specify the version of the API being requested. If not specied, the latest version would be used.

Responses

Response samples

Content type

application/hal+json

{"id": "prd_01J7ZWP2Q7C2VJRAPW5D62GQEH",
"status": "active",
"created_at": "2024-09-17T11:43:02.023",
"start_at": "2024-09-17T11:43:03.579Z",
"started_at": "2024-09-17T11:43:04.375Z",
"end_at": "2024-10-17T11:43:01.579Z",
"_embedded": {"product_offering": {"id": "prdoff_01J7ZWNYNYVJYKWGJR98FA3NZS",
"name": "Local Germany 1 Month 500 MB",
"type": "addon",
"validity": {"type": "duration",
"unit": "month",
"unit_count": 1,
"is_recurrent": false
},
"_embedded": {"allowances": [{"type": "data",
"unit": "megabytes",
"unit_count": 500,
"is_unlimited": false,
"_embedded": {"coverage_area": {"id": "cov_01J7ZWNXBNSHG0Q0RWERPP5QDW",
"name": "Germany",
"type": "local",
"created_at": "2024-09-17T11:42:56.875Z",
"updated_at": "2024-09-17T14:45:03.234Z",
"countries": ["DE"
],
"_links": {"self": {"href": "https://api.1global.com/connect/coverage-areas/cov_01J7ZWNXBNSHG0Q0RWERPP5QDW"
}
}
}
}
}
]
},
"_links": {"self": {"href": "https://api.1global.com/connect/product-offerings/prdoff_01J7ZWNYNYVJYKWGJR98FA3NZS"
}
}
},
"balances": [{"type": "limited",
"allowance_type": "data",
"unit": "bytes",
"initial": 524288000,
"remaining": 512154000,
"spent": 12134000
}
],
"prices": [{"type": "one_time",
"unit_amount": 1,
"currency": "EUR"
}
]
},
"_links": {"self": {"href": "https://api.1global.com/connect/products/prd_01J7ZWP2Q7C2VJRAPW5D62GQEH"
},
"order": {"href": "https://api.1global.com/connect/orders/ord_01J7ZWP1X8MBE7GZ73M75JEPB2"
},
"subscription": {"href": "https://api.1global.com/connect/subscriptions/subs_01J7ZWP28JKQAFY37GEX8XN8FS"
},
"cancel": {"href": "https://api.1global.com/connect/products/prd_01J7ZWP2Q7C2VJRAPW5D62GQEH/cancel"
}
}
}

Cancel a Product

Cancels a product. Only products in status active, scheduled or pending first usage can be canceled.

Authorizations:

oAuth2

path Parameters

product-id

required

string (ProductId) <= 100 characters

Example: prd_01BX5ZZKBKACTAV9WEVGEMMVRY

An identifier of the product.

header Parameters

Correlation-Id	string An unique identifier provided by the client that allows the request to be traced through the system.
Api-Version	string (ApiVersion) Value: "2025-01-28" This header is used to specify the version of the API being requested. If not specied, the latest version would be used.

Request Body schema: application/json
required

cancellation_mode

required

string

Enum: "immediate" "end_of_cycle"

The mode of cancellation

Responses

Request samples

Payload

Content type

application/json

Example

Canceled Product - Immediate

{"cancellation_mode": "immediate"
}

Response samples

Content type

application/hal+json

Example

Canceled Product

{"id": "prd_01J82FWNGE033C2DEMCRPY1427",
"status": "canceled",
"created_at": "2024-09-18T11:57:10.029Z",
"expire_at": "2025-09-18T11:57:08.570Z",
"ended_at": "2024-09-19T12:10:40.218Z",
"_embedded": {"product_offering": {"id": "prdoff_01J8091PFJ4XWGXW5VN6T6JV3A",
"name": "Local Zimbabwe - 7 Days",
"type": "addon",
"validity": {"type": "duration",
"unit": "day",
"unit_count": 7,
"is_recurrent": false
},
"_embedded": {"allowances": [{"type": "data",
"unit": "gigabytes",
"unit_count": 1,
"is_unlimited": false,
"_embedded": {"coverage_area": {"id": "cov_01J8091P6TD2DT8R1VYEADGXSJ",
"name": "Zimbabwe",
"type": "local",
"created_at": "2024-09-17T15:19:05.690Z",
"updated_at": "2024-09-17T14:45:03.234Z",
"countries": ["ZW"
],
"_links": {"self": {"href": "https://api.1global.com/connect/coverage-areas/cov_01J8091P6TD2DT8R1VYEADGXSJ"
}
}
}
}
}
]
},
"_links": {"self": {"href": "https://api.1global.com/connect/product-offerings/prdoff_01J8091PFJ4XWGXW5VN6T6JV3A"
}
}
},
"balances": [{"type": "limited",
"allowance_type": "data",
"unit": "bytes",
"initial": 1073741824,
"remaining": 1073741824,
"spent": 0
}
],
"prices": [{"type": "one_time",
"unit_amount": 1,
"currency": "USD"
}
]
},
"_links": {"self": {"href": "https://api.1global.com/connect/products/prd_01J82FWNGE033C2DEMCRPY1427"
},
"order": {"href": "https://api.1global.com/connect/orders/ord_01J82FWM1SNAPXYHYY50XP3SMN"
},
"subscription": {"href": "https://api.1global.com/connect/subscriptions/subs_01J82FWMHCXZSAR4TMDA19Y4ZA"
}
}
}

Service Providers

List all service-provider

Returns a list of service-provider

Authorizations:

oAuth2

query Parameters

limit	integer <int32> (Limit) [ 1 .. 40 ] Default: 10 The page size filter
cursor	string (Cursor) A base64 encoded string that uniquely identifies the first entry of a query result.
country	string (PortingCountry) Value: "DE" The supported country codes according to ISO 3166-1 alpha-2
status	string (ServiceProviderStatus) Enum: "active" "inactive"

header Parameters

Correlation-Id	string An unique identifier provided by the client that allows the request to be traced through the system.
Api-Version	string (ApiVersion) Value: "2025-01-28" This header is used to specify the version of the API being requested. If not specied, the latest version would be used.

Responses

Response samples

Content type

application/hal+json

{"_embedded": {"service_providers": [{"id": "spro_01J6795M195EXEECTPY9Y3QD66",
"name": "Truphone",
"country": "DE",
"status": "active",
"created_at": "2024-08-30T10:42:34.309Z",
"updated_at": "2024-08-30T10:42:34.309Z",
"_links": {"self": {"href": "https://api.1global.com/connect/service-providers/spro_01J6795M195EXEECTPY9Y3QD66"
}
}
},
{"id": "spro_01JGYX8WRXYFT2GX3MVAKG8NPZ",
"name": "1&1 Internet AG",
"country": "DE",
"status": "active",
"created_at": "2024-08-30T10:42:34.309Z",
"updated_at": "2024-08-30T10:42:34.309Z",
"_links": {"self": {"href": "https://api.1global.com/connect/service-providers/spro_01J6795M195EXEECTPY9Y3QD66"
}
}
}
]
},
"_links": {"self": {"href": "https://api.1global.com/connect/service-providers"
},
"next": {"href": "https://api.1global.com/connect/service-providers?cursor=nextCursor&limit=2"
},
"prev": {"href": "https://api.1global.com/connect/service-providers??cursor=prevCursor&limit=2"
}
}
}

Get a service-provider by id

Authorizations:

oAuth2

path Parameters

service-provider-id

required

string (ServiceProviderId) <= 100 characters

Example: spro_01HV3KWPNRCT870WV3XG41CAT3

The resource identifier.

header Parameters

Correlation-Id	string An unique identifier provided by the client that allows the request to be traced through the system.
Api-Version	string (ApiVersion) Value: "2025-01-28" This header is used to specify the version of the API being requested. If not specied, the latest version would be used.

Responses

Response samples

Content type

application/hal+json

{"id": "spro_01HV3KWPNRCT870WV3XG41CAT3",
"name": "T-Mobile",
"country": "DE",
"status": "active",
"created_at": "2024-10-01T14:28:17.456Z",
"updated_at": "2024-10-01T14:28:17.456Z",
"_links": {"self": {"href": "https://api.1global.com/connect/service-providers/spro_01HV3KWPNRCT870WV3XG41CAT3"
}
}
}

Subscribers

Subscribers represent end users and can have a set of Subscriptions

Creates a new Subscriber

Authorizations:

oAuth2

header Parameters

Correlation-Id	string An unique identifier provided by the client that allows the request to be traced through the system.
Api-Version	string (ApiVersion) Value: "2025-01-28" This header is used to specify the version of the API being requested. If not specied, the latest version would be used.

Request Body schema: application/json
required

account_id required	string (AccountId) <= 100 characters A string that uniquely identifies an Account
locale	string The locale to be associated on the subscriber, if no value is passed it sets the default one 'en-GB'
first_name required	string The Subscriber's first name
last_name required	string The Subscriber's last name
email required	string The Subscriber's email
required	GlobalAddress (object) or NAAddress (object) (Address)
birth_date	string <date> (SubscriberBirthDate) The Subscriber's birthdate. Depending on the country the field might be required.

Responses

Request samples

Payload

Content type

application/json

Example

Subscriber with address in US

{"account_id": "acc_01HRC2T6WK4CMVGFXA2RESTQ97",
"first_name": "John",
"last_name": "Doe",
"email": "john.doe@dummy.com",
"address": {"line1": "123 Main St",
"line2": "Apt 4B",
"city": "Los Angeles",
"country": "US",
"state": "CA",
"postal_code": "90001"
},
"birth_date": "2074-04-12",
"locale": "en-GB"
}

Response samples

Content type

application/hal+json

{"id": "subr_01HRC2T6WK4CMVGFXA2RESTQ97",
"created_at": "2023-01-01T00:00:00Z",
"updated_at": "2023-05-21T00:00:00Z",
"first_name": "John",
"last_name": "Doe",
"email": "john.doe@dummy.com",
"locale": "en-GB",
"address": {"line1": "123 Main St",
"line2": "Apt 4B",
"city": "Los Angeles",
"country": "US",
"state": "CA",
"postal_code": "90001"
},
"birth_date": "2073-06-01",
"_embedded": {"account": {"id": "acc_01HRC2T6WK4CMVGFXA2RESTQ97",
"_links": {"self": {"href": "http://api.1global.com/connect/accounts/acc_01HRC2T6WK4CMVGFXA2RESTQ97"
}
}
}
},
"_links": {"self": {"href": "http://api.1global.com/connect/subscribers/subr_01HRC2T6WK4CMVGFXA2RESTQ97"
},
"subscriptions": {"href": "http://api.1global.com/connect/subscriptions?subscriber-id=subr_01HRC2T6WK4CMVGFXA2RESTQ97"
}
}
}

List all subscribers

Returns a list of subscribers

Authorizations:

oAuth2

query Parameters

cursor	string (Cursor) A base64 encoded string that uniquely identifies the first entry of a query result.
limit	integer <int32> (Limit) [ 1 .. 40 ] Default: 10 The page size filter

header Parameters

Correlation-Id	string An unique identifier provided by the client that allows the request to be traced through the system.
Api-Version	string (ApiVersion) Value: "2025-01-28" This header is used to specify the version of the API being requested. If not specied, the latest version would be used.

Responses

Response samples

Content type

application/hal+json

{"_embedded": {"subscribers": [{"id": "subr_01HRC2T6WK4CMVGFXA2RESTQ97",
"created_at": "2023-01-01T00:00:00Z",
"updated_at": "2023-05-21T00:00:00Z",
"first_name": "John",
"last_name": "Doe",
"email": "john.doe@dummy.com",
"address": {"line1": "123 Main St",
"line2": "Apt 4B",
"city": "Los Angeles",
"country": "US",
"state": "CA",
"postal_code": "90001"
},
"locale": "en-GB",
"_embedded": {"account": {"id": "acc_01HRC2T6WK4CMVGFXA2RESTQ97",
"_links": {"self": {"href": "http://api.1global.com/connect/accounts/acc_01HRC2T6WK4CMVGFXA2RESTQ97"
}
}
}
},
"_links": {"self": {"href": "http://api.1global.com/connect/subscriber/subr_01HRC2T6WK4CMVGFXA2RESTQ97"
},
"subscriptions": {"href": "http://api.1global.com/connect/subscriptions?subscriber-id=subr_01HRC2T6WK4CMVGFXA2RESTQ97"
}
}
},
{"id": "subr_02HRC2T6WK4CMVGFXA2RESTQ98",
"created_at": "2023-02-01T00:00:00Z",
"updated_at": "2023-06-21T00:00:00Z",
"first_name": "Maria",
"last_name": "Silva",
"email": "maria.silva@dummy.com",
"address": {"line1": "Avenida da Boavista 345",
"line2": "3 Esq",
"city": "Porto",
"country": "PT",
"postal_code": "1000-001"
},
"birth_date": "2077-04-23",
"locale": "en-GB",
"_embedded": {"account": {"id": "acc_01HRC2T6WK4CMVGFXA2RESTQ97",
"_links": {"self": {"href": "http://api.1global.com/connect/accounts/acc_01HRC2T6WK4CMVGFXA2RESTQ97"
}
}
}
},
"_links": {"self": {"href": "http://api.1global.com/connect/subscribers/subr_02HRC2T6WK4CMVGFXA2RESTQ98"
},
"subscriptions": {"href": "http://api.1global.com/connect/subscriptions?subscriber-id=subr_02HRC2T6WK4CMVGFXA2RESTQ98"
}
}
}
]
},
"_links": {"self": {"href": "http://api.1global.com/connect/subscribers?limit=2"
},
"prev": {"href": "http://api.1global.com/connect/subscribers?cursor=eyJzbyI6eyJkIjoiREVTQyIsInAiOiJleHRlcm5hbElkIn0sInNpZCI6bnVsbCwicyI6bnVsbCwidCI6Ik5FWFQiLCJpZCI6InN1YnNfMDFKQTVESzdEOFBEQ0hTSDI3RjMzUjVXNDYifQ==&limit=20"
},
"next": {"href": "http://api.1global.com/connect/subscribers?cursor=eyJzbyI6eyJkIjoiREVTQyIsInAiOiJleHRlcm5hbElkIn0sInNpZCI6bnVsbCwicyI6bnVsbCwidCI6Ik5FWFQiLCJpZCI6InN1YnNfMDFKQTVESzdEOFBEQ0hTSDI3RjMzUjVXNDYifQ==&limit=20"
}
}
}

Retrieve a subscriber

Retrieves the details of an existing subscriber

Authorizations:

oAuth2

path Parameters

subscriber-id

required

string (SubscriberId) <= 100 characters

Example: subr_01HRC2T6WK4CMVGFXA2RESTQ97

An identifier of the subscriber.

header Parameters

Correlation-Id	string An unique identifier provided by the client that allows the request to be traced through the system.
Api-Version	string (ApiVersion) Value: "2025-01-28" This header is used to specify the version of the API being requested. If not specied, the latest version would be used.

Responses

Response samples

Content type

application/hal+json

Example

Subscriber with address in US (California)

{"id": "subr_01HRC2T6WK4CMVGFXA2RESTQ97",
"created_at": "2023-01-01T00:00:00Z",
"updated_at": "2023-05-21T00:00:00Z",
"first_name": "John",
"last_name": "Doe",
"email": "john.doe@dummy.com",
"locale": "en-GB",
"address": {"line1": "123 Main St",
"line2": "Apt 4B",
"city": "Los Angeles",
"country": "US",
"state": "CA",
"postal_code": "90001"
},
"birth_date": "2073-06-01",
"_embedded": {"account": {"id": "acc_01HRC2T6WK4CMVGFXA2RESTQ97",
"_links": {"self": {"href": "http://api.1global.com/connect/accounts/acc_01HRC2T6WK4CMVGFXA2RESTQ97"
}
}
}
},
"_links": {"self": {"href": "http://api.1global.com/connect/subscribers/subr_01HRC2T6WK4CMVGFXA2RESTQ97"
},
"subscriptions": {"href": "http://api.1global.com/connect/subscriptions?subscriber-id=subr_01HRC2T6WK4CMVGFXA2RESTQ97"
}
}
}

Updates a Subscriber

Updates an existing Subscriber

Authorizations:

oAuth2

path Parameters

subscriber-id

required

string (SubscriberId) <= 100 characters

Example: subr_01HRC2T6WK4CMVGFXA2RESTQ97

An identifier of the subscriber.

header Parameters

Correlation-Id	string An unique identifier provided by the client that allows the request to be traced through the system.
Api-Version	string (ApiVersion) Value: "2025-01-28" This header is used to specify the version of the API being requested. If not specied, the latest version would be used.

Request Body schema: application/json
required

locale	string The locale to be associated on the subscriber, if no value is passed it sets the default one 'en-GB'
first_name	string The Subscriber's first name
last_name	string The Subscriber's last name
email	string The Subscriber's email
	object (AddressNonRequired) The Subscriber's address
birth_date	string <date> (SubscriberBirthDate) The Subscriber's birthdate. Depending on the country the field might be required.

Responses

Request samples

Payload

Content type

application/json

Example

Subscriber with address in US

{"first_name": "John",
"last_name": "Doe",
"email": "john.doe@dummy.com",
"address": {"line1": "123 Main St",
"line2": "Apt 4B",
"city": "Los Angeles",
"country": "US",
"state": "CA",
"postal_code": "90001"
},
"birth_date": "2074-04-12",
"locale": "en-GB"
}

Response samples

Content type

application/hal+json

Example

Subscriber with address in US (California)

{"id": "subr_01HRC2T6WK4CMVGFXA2RESTQ97",
"created_at": "2023-01-01T00:00:00Z",
"updated_at": "2023-05-21T00:00:00Z",
"first_name": "John",
"last_name": "Doe",
"email": "john.doe@dummy.com",
"locale": "en-GB",
"address": {"line1": "123 Main St",
"line2": "Apt 4B",
"city": "Los Angeles",
"country": "US",
"state": "CA",
"postal_code": "90001"
},
"birth_date": "2073-06-01",
"_embedded": {"account": {"id": "acc_01HRC2T6WK4CMVGFXA2RESTQ97",
"_links": {"self": {"href": "http://api.1global.com/connect/accounts/acc_01HRC2T6WK4CMVGFXA2RESTQ97"
}
}
}
},
"_links": {"self": {"href": "http://api.1global.com/connect/subscribers/subr_01HRC2T6WK4CMVGFXA2RESTQ97"
},
"subscriptions": {"href": "http://api.1global.com/connect/subscriptions?subscriber-id=subr_01HRC2T6WK4CMVGFXA2RESTQ97"
}
}
}

Subscriptions

Subscriptions have SIM Profiles and bundled products that are purchased

List all subscriptions

Returns a list of subscriptions

Authorizations:

oAuth2

query Parameters

account-id	string (AccountId) <= 100 characters Example: account-id=acc_01BX5ZZKBKACTAV9WEVGEMMVRY A string that uniquely identifies an Account
subscriber-id	string (SubscriberId) <= 100 characters Example: subscriber-id=subr_01HRC2T6WK4CMVGFXA2RESTQ97 An identifier of the subscriber that owns the subscription.
cursor	string (Cursor) A base64 encoded string that uniquely identifies the first entry of a query result.
limit	integer <int32> (Limit) [ 1 .. 40 ] Default: 10 The page size filter
status	string (SubscriptionStatus) Enum: "created" "active" "grace" "suspended" "deactivated" "terminated" "canceled" Example: status=active The Subscription's status

header Parameters

Correlation-Id	string An unique identifier provided by the client that allows the request to be traced through the system.
Api-Version	string (ApiVersion) Value: "2025-01-28" This header is used to specify the version of the API being requested. If not specied, the latest version would be used.

Responses

Response samples

Content type

application/hal+json

{"_embedded": {"subscriptions": [{"id": "subs_01BX5ZZKBKACTAV9WEVGEMMVRY",
"status": "terminated",
"created_at": "2023-01-01T00:00:00.100Z",
"updated_at": "2023-05-21T00:00:00.500Z",
"_embedded": {"sim_profile": {"iccid": "8999999999990242084",
"sim_type": "esim"
},
"account": {"id": "acc_01HRC2T6WK4CMVGFXA2RESTQ97",
"_links": {"self": {"href": "http://api.1global.com/connect/accounts/acc_01HRC2T6WK4CMVGFXA2RESTQ97"
}
}
}
},
"_links": {"self": {"href": "http://api.1global.com/connect/subscriptions/subs_01BX5ZZKBKACTAV9WEVGEMMVRY"
}
}
},
{"id": "subs_02BX5ZZKBKACTAV9WEVGEMMVZS",
"status": "active",
"created_at": "2022-01-01T00:00:00.100Z",
"updated_at": "2022-05-21T00:00:00.500Z",
"_embedded": {"sim_profile": {"iccid": "8999999999990242084",
"sim_type": "esim"
},
"account": {"id": "acc_01HRC2T6WK4CMVGFXA2RESTQ97",
"_links": {"self": {"href": "http://api.1global.com/connect/accounts/acc_01HRC2T6WK4CMVGFXA2RESTQ97"
}
}
}
},
"_links": {"self": {"href": "http://api.1global.com/connect/subscriptions/subs_02BX5ZZKBKACTAV9WEVGEMMVZS"
}
}
}
]
},
"_links": {"self": {"href": "http://api.1global.com/connect/subscriptions"
},
"prev": {"href": "http://api.1global.com/connect/subscriptions?cursor=eyJzbyI6eyJkIjoiREVTQyIsInAiOiJleHRlcm5hbElkIn0sInNpZCI6bnVsbCwicyI6bnVsbCwidCI6Ik5FWFQiLCJpZCI6InN1YnNfMDFKQTVESzdEOFBEQ0hTSDI3RjMzUjVXNDYifQ==&limit=10"
},
"next": {"href": "http://api.1global.com/connect/subscriptions?cursor=eyJzbyI6eyJkIjoiREVTQyIsInAiOiJleHRlcm5hbElkIn0sInNpZCI6bnVsbCwicyI6bnVsbCwidCI6Ik5FWFQiLCJpZCI6InN1YnNfMDFKQTVESzdEOFBEQ0hTSDI3RjMzUjVXNDYifQ==&limit=10"
}
}
}

Retrieve a subscription

Retrieves the details of an existing subscription

Authorizations:

oAuth2

path Parameters

subscription-id

required

string (SubscriptionId) <= 100 characters

Example: subs_01J9XJ11WTYFWFH5JD2YM1S18S

A string that uniquely identifies a Subscription

header Parameters

Correlation-Id	string An unique identifier provided by the client that allows the request to be traced through the system.
Api-Version	string (ApiVersion) Value: "2025-01-28" This header is used to specify the version of the API being requested. If not specied, the latest version would be used.

Responses

Response samples

Content type

application/hal+json

Example

Created subscription

{"id": "subs_01BX5ZZKBKACTAV9WEVGEMMVRY",
"created_at": "2023-01-01T00:00:00Z",
"updated_at": "2023-05-21T00:00:00Z",
"status": "created",
"_embedded": {"sim_profile": {"iccid": "8988211234567890123",
"sim_type": "esim",
"profile_status": "installed",
"matching_id": "5C-ZYXZZ-1R54O94",
"smdp_address": "rsp.truphone.com"
},
"account": {"id": "acc_01HRC2T6WK4CMVGFXA2RESTQ97",
"_links": {"self": {"href": "http://api.1global.com/connect/accounts/acc_01HRC2T6WK4CMVGFXA2RESTQ97"
}
}
}
},
"_links": {"self": {"href": "http://api.1global.com/connect/subscriptions/subs_01BX5ZZKBKACTAV9WEVGEMMVRY"
},
"qrcode": {"href": "http://api.1global.com/qrcode/v1/esim/LPA:1$rsp.truphone.com$5C-ZYXZZ-1R54O94"
},
"products": {"href": "http://api.1global.com/connect/products?subscription=subs_01BX5ZZKBKACTAV9WEVGEMMVRY"
},
"subscriber": {"href": "http://api.1global.com/connect/subscriber/subr_02BX5ZZKBKACTAV9WEVGEMMVRY"
}
}
}

Graces a Subscription

Applies to active subscriptions when service should be limited

Authorizations:

oAuth2

path Parameters

subscription-id

required

string (SubscriptionId) <= 100 characters

Example: subs_01J9XJ11WTYFWFH5JD2YM1S18S

A string that uniquely identifies a Subscription

header Parameters

Correlation-Id	string An unique identifier provided by the client that allows the request to be traced through the system.
Api-Version	string (ApiVersion) Value: "2025-01-28" This header is used to specify the version of the API being requested. If not specied, the latest version would be used.

Responses

Response samples

Content type

application/hal+json

{"id": "subs_01BX5ZZKBKACTAV9WEVGEMMVRY",
"created_at": "2023-01-01T00:00:00Z",
"updated_at": "2023-05-21T00:00:00Z",
"status": "grace",
"_embedded": {"sim_profile": {"iccid": "8988211234567890123",
"sim_type": "esim",
"profile_status": "installed",
"matching_id": "5C-ZYXZZ-1R54O94",
"smdp_address": "rsp.truphone.com"
},
"active_phone_numbers": [{"id": "pn_01BX5ZZKBKACTAV9WEVGEMUIJ6",
"status": "active",
"created_at": "2023-01-01T00:30:00Z",
"msisdn": "+4912984900817",
"country": "DE",
"is_primary": true,
"_links": {"self": {"href": "https://api.1global.com/connect/phone-numbers/pn_01BX5ZZKBKACTAV9WEVGEMUIJ6"
},
"disable-porting-opt-in": {"href": "https://api.1global.com/connect/phone-numbers/pn_01BX5ZZKBKACTAV9WEVGEMUIJ6/disable-porting-opt-in"
},
"subscription": {"href": "https://api.1global.com/connect/subscriptions/subs_01J67SMMCM050XM1C1ABQNFD9K"
}
}
}
],
"account": {"id": "acc_01HRC2T6WK4CMVGFXA2RESTQ97",
"_links": {"self": {"href": "http://api.1global.com/connect/accounts/acc_01HRC2T6WK4CMVGFXA2RESTQ97"
}
}
}
},
"_links": {"self": {"href": "http://api.1global.com/connect/subscriptions/subs_01BX5ZZKBKACTAV9WEVGEMMVRY"
},
"qrcode": {"href": "http://api.1global.com/qrcode/v1/esim/LPA:1$rsp.truphone.com$5C-ZYXZZ-1R54O94"
},
"products": {"href": "http://api.1global.com/connect/products?subscription=subs_01BX5ZZKBKACTAV9WEVGEMMVRY"
},
"subscriber": {"href": "http://api.1global.com/connect/subscriber/subr_02BX5ZZKBKACTAV9WEVGEMMVRY"
}
}
}

Suspends a Subscription

Applies to subscriptions in grace status when service should be suspended

Authorizations:

oAuth2

path Parameters

subscription-id

required

string (SubscriptionId) <= 100 characters

Example: subs_01J9XJ11WTYFWFH5JD2YM1S18S

A string that uniquely identifies a Subscription

header Parameters

Correlation-Id	string An unique identifier provided by the client that allows the request to be traced through the system.
Api-Version	string (ApiVersion) Value: "2025-01-28" This header is used to specify the version of the API being requested. If not specied, the latest version would be used.

Responses

Response samples

Content type

application/hal+json

{"id": "subs_01BX5ZZKBKACTAV9WEVGEMMVRY",
"created_at": "2023-01-01T00:00:00Z",
"updated_at": "2023-05-21T00:00:00Z",
"status": "suspended",
"_embedded": {"sim_profile": {"iccid": "8988211234567890123",
"sim_type": "esim",
"profile_status": "installed",
"matching_id": "5C-ZYXZZ-1R54O94",
"smdp_address": "rsp.truphone.com"
},
"account": {"id": "acc_01HRC2T6WK4CMVGFXA2RESTQ97",
"_links": {"self": {"href": "http://api.1global.com/connect/accounts/acc_01HRC2T6WK4CMVGFXA2RESTQ97"
}
}
}
},
"_links": {"self": {"href": "http://api.1global.com/connect/subscriptions/subs_01BX5ZZKBKACTAV9WEVGEMMVRY"
},
"qrcode": {"href": "http://api.1global.com/qrcode/v1/esim/LPA:1$rsp.truphone.com$5C-ZYXZZ-1R54O94"
},
"products": {"href": "http://api.1global.com/connect/products?subscription=subs_01BX5ZZKBKACTAV9WEVGEMMVRY"
},
"subscriber": {"href": "http://api.1global.com/connect/subscriber/subr_02BX5ZZKBKACTAV9WEVGEMMVRY"
}
}
}

Deactivates a Subscription

Can be used to temporary deactivate a subscription without affecting normal livecycle of products

Authorizations:

oAuth2

path Parameters

subscription-id

required

string (SubscriptionId) <= 100 characters

Example: subs_01J9XJ11WTYFWFH5JD2YM1S18S

A string that uniquely identifies a Subscription

header Parameters

Correlation-Id	string An unique identifier provided by the client that allows the request to be traced through the system.
Api-Version	string (ApiVersion) Value: "2025-01-28" This header is used to specify the version of the API being requested. If not specied, the latest version would be used.

Responses

Response samples

Content type

application/hal+json

{"id": "subs_01BX5ZZKBKACTAV9WEVGEMMVRY",
"created_at": "2023-01-01T00:00:00Z",
"updated_at": "2023-05-21T00:00:00Z",
"status": "deactivated",
"_embedded": {"sim_profile": {"iccid": "8988211234567890123",
"sim_type": "esim",
"profile_status": "installed",
"matching_id": "5C-ZYXZZ-1R54O94",
"smdp_address": "rsp.truphone.com"
},
"account": {"id": "acc_01HRC2T6WK4CMVGFXA2RESTQ97",
"_links": {"self": {"href": "http://api.1global.com/connect/accounts/acc_01HRC2T6WK4CMVGFXA2RESTQ97"
}
}
}
},
"_links": {"self": {"href": "http://api.1global.com/connect/subscriptions/subs_01BX5ZZKBKACTAV9WEVGEMMVRY"
},
"qrcode": {"href": "http://api.1global.com/qrcode/v1/esim/LPA:1$rsp.truphone.com$5C-ZYXZZ-1R54O94"
},
"products": {"href": "http://api.1global.com/connect/products?subscription=subs_01BX5ZZKBKACTAV9WEVGEMMVRY"
},
"subscriber": {"href": "http://api.1global.com/connect/subscriber/subr_02BX5ZZKBKACTAV9WEVGEMMVRY"
}
}
}

Resumes a Subscription

Resumes a deactivated subscription back to active status

Authorizations:

oAuth2

path Parameters

subscription-id

required

string (SubscriptionId) <= 100 characters

Example: subs_01J9XJ11WTYFWFH5JD2YM1S18S

A string that uniquely identifies a Subscription

header Parameters

Correlation-Id	string An unique identifier provided by the client that allows the request to be traced through the system.
Api-Version	string (ApiVersion) Value: "2025-01-28" This header is used to specify the version of the API being requested. If not specied, the latest version would be used.

Responses

Response samples

Content type

application/hal+json

{"id": "subs_01BX5ZZKBKACTAV9WEVGEMMVRY",
"created_at": "2023-01-01T00:00:00Z",
"updated_at": "2023-05-21T00:00:00Z",
"status": "active",
"_embedded": {"sim_profile": {"iccid": "8988211234567890123",
"sim_type": "esim",
"profile_status": "installed",
"matching_id": "5C-ZYXZZ-1R54O94",
"smdp_address": "rsp.truphone.com"
},
"account": {"id": "acc_01HRC2T6WK4CMVGFXA2RESTQ97",
"_links": {"self": {"href": "http://api.1global.com/connect/accounts/acc_01HRC2T6WK4CMVGFXA2RESTQ97"
}
}
}
},
"_links": {"self": {"href": "http://api.1global.com/connect/subscriptions/subs_01BX5ZZKBKACTAV9WEVGEMMVRY"
},
"qrcode": {"href": "http://api.1global.com/qrcode/v1/esim/LPA:1$rsp.truphone.com$5C-ZYXZZ-1R54O94"
},
"products": {"href": "http://api.1global.com/connect/products?subscription=subs_01BX5ZZKBKACTAV9WEVGEMMVRY"
},
"subscriber": {"href": "http://api.1global.com/connect/subscriber/subr_02BX5ZZKBKACTAV9WEVGEMMVRY"
}
}
}

Events

Events are triggered when important domain transitions happen

Balance Threshold Webhook

This webhook is triggered when a product balance threshold is reached.

Authorizations:

basicAuth

Request Body schema: application/hal+json
required

Product balance threshold event schema

id required	string (EventId) <= 100 characters A string that uniquely identifies an Event
type required	string Value: "balance.threshold.exceeded" The type of notification
created_at required	string <date-time> (Iso8601DateTime) The Date Time format according to the ISO 8601
required	object

Responses

Request samples

Payload

Content type

application/hal+json

{"id": "evt_01J494G6WZAR2E2808Z8M07K4Z",
"type": "balance.threshold.exceeded",
"created_at": "2021-02-01T14:28:17.967Z",
"data": {"threshold": {"allowance_type": "data",
"percentage": 80
},
"product": {"id": "prd_01J806F9TNFYTQM3Z4THPTJEVY",
"status": "active",
"created_at": "2024-09-17T14:34:06.037Z",
"started_at": "2024-09-17T14:35:31.559Z",
"expire_at": "2025-09-17T14:34:03.946Z",
"end_at": "2024-10-17T14:35:31.559Z",
"_embedded": {"product_offering": {"id": "prdoff_01J7ZWQW25H38MHADHDQ21H28W",
"name": "Local Germany 1Month 500MB",
"type": "addon",
"validity": {"type": "duration",
"unit": "month",
"unit_count": 1,
"is_recurrent": false
},
"_embedded": {"allowances": [{"type": "data",
"unit": "megabytes",
"unit_count": 500,
"is_unlimited": false,
"_embedded": {"coverage_area": {"id": "cov_01J7ZWQVSNTKXMEZ77GS81ZG2T",
"name": "Germany",
"type": "local",
"created_at": "2024-09-17T11:44:00.818Z",
"updated_at": "2024-09-17T11:44:00.818Z",
"countries": ["DE"
],
"_links": {"self": {"href": "https://api.1global.com/connect/coverage-areas/cov_01J7ZWQVSNTKXMEZ77GS81ZG2T"
}
}
}
}
}
]
},
"_links": {"self": {"href": "https://api.1global.com/connect/product-offerings/prdoff_01J7ZWQW25H38MHADHDQ21H28W"
}
}
},
"balances": [{"type": "limited",
"allowance_type": "data",
"unit": "bytes",
"initial": 524288000,
"remaining": 123000,
"spent": 524165000
}
],
"prices": [{"type": "one_time",
"unit_amount": 0,
"currency": "EUR"
}
]
},
"_links": {"self": {"href": "https://api.1global.com/connect/products/prd_01J806F9TNFYTQM3Z4THPTJEVY"
},
"cancel": {"href": "https://api.1global.com/connect/products/prd_01J806F9TNFYTQM3Z4THPTJEVY/cancel"
},
"order": {"href": "https://api.1global.com/connect/orders/ord_01J806F7RDT6ERDN47MHPC6AA2"
},
"subscription": {"href": "https://api.1global.com/connect/subscriptions/subs_01J806F86A8YJDPDX0DY9ZM7TD"
}
}
}
}
}

Product Depleted Webhook

This webhook is triggered when a product is depleted.

Authorizations:

basicAuth

Request Body schema: application/hal+json
required

Product depleted event notification payload

id required	string (EventId) <= 100 characters A string that uniquely identifies an Event
type required	string Value: "product.depleted" The type of notification
created_at required	string <date-time> (Iso8601DateTime) The Date Time format according to the ISO 8601
required	object

Responses

Request samples

Payload

Content type

application/hal+json

{"id": "evt_01J494G6WZAR2E2808Z8M07K4Z",
"type": "product.depleted",
"created_at": "2021-02-01T14:28:17.967Z",
"data": {"product": {"id": "prd_01J494WK30DVCMB6ZPYWN21APK",
"status": "depleted",
"created_at": "2023-05-06T16:59:17.000Z",
"start_at": "2023-05-06T16:59:20.000Z",
"started_at": "2023-05-06T16:59:17.967Z",
"expire_at": "2023-10-21T14:28:17.967Z",
"end_at": "2023-06-07T16:52:17.967Z",
"ended_at": "2023-05-10T16:52:17.967Z",
"_embedded": {"product_offering": {"id": "prdoff_01HW386JNMYHY5G9VXPNK49ABS",
"name": "Local Macedonia - 15 Days - 70 GB",
"type": "addon",
"validity": {"type": "duration",
"unit": "day",
"unit_count": 15,
"is_recurrent": false
},
"_embedded": {"allowances": [{"type": "data",
"unit": "bytes",
"unit_count": 70,
"is_unlimited": false,
"_embedded": {"coverage_area": {"id": "cov_01J7ZWQVSNTKXMEZ77GS81ZG2T",
"name": "Macedonia",
"type": "local",
"created_at": "2024-09-17T11:44:00.818Z",
"updated_at": "2024-10-10T11:44:00.000Z",
"countries": ["DE"
],
"_links": {"self": {"href": "https://api.1global.com/connect/coverage-areas/cov_01J7ZWQVSNTKXMEZ77GS81ZG2T"
}
}
}
}
}
]
},
"_links": {"self": {"href": "https://api.1global.com/connect/product-offerings/prdoff_01HW386JNMYHY5G9VXPNK49ABS"
}
}
},
"balances": [{"type": "limited",
"allowance_type": "data",
"unit": "bytes",
"initial": 524288000,
"remaining": 0,
"spent": 524288000
}
],
"prices": [{"type": "recurring",
"unit_amount": 19,
"recurrence": {"unit": "week",
"unit_count": 1
},
"currency": "EUR"
}
]
},
"_links": {"self": {"href": "https://api.1global.com/consumer/product/products/prd_01J494WK30DVCMB6ZPYWN21APK"
},
"order": {"href": "https://api.1global.com/consumer/order/orders/ord_01HRCZZKEXG4QSYNVSD6FHFT0D"
},
"subscription": {"href": "https://api.1global.com/consumer/subscription/subscriptions/subs_01J0BQZ8MZ6C1V8GPYYQC0KZ2S"
}
}
}
}
}

Product Terminated Webhook

This webhook is triggered when a product is terminated.

Authorizations:

basicAuth

Request Body schema: application/hal+json
required

Product terminated notification payload

id required	string (EventId) <= 100 characters A string that uniquely identifies an Event
type required	string Value: "product.terminated" The type of notification
created_at required	string <date-time> (Iso8601DateTime) The Date Time format according to the ISO 8601
required	object

Responses

Request samples

Payload

Content type

application/hal+json

{"id": "evt_01J494G6WZAR2E2808Z8M07K4Z",
"type": "product.terminated",
"created_at": "2021-02-01T14:28:17.967Z",
"data": {"product": {"id": "prd_01J494WK30DVCMB6ZPYWN21APK",
"status": "terminated",
"created_at": "2024-08-02T08:56:46.944Z",
"started_at": "2023-05-06T16:59:17.967Z",
"start_at": "2023-05-06T16:59:17.967Z",
"end_at": "2023-05-07T16:52:17.967Z",
"ended_at": "2023-05-07T16:52:17.967Z",
"_embedded": {"product_offering": {"id": "prdoff_01HW386JNMYHY5G9VXPNK49ABS",
"name": "Local Macedonia - 15 Days - 70 GB",
"type": "addon",
"validity": {"type": "duration",
"unit": "day",
"unit_count": 15,
"is_recurrent": false
},
"_embedded": {"allowances": [{"type": "data",
"unit": "bytes",
"unit_count": 70,
"is_unlimited": false,
"_embedded": {"coverage_area": {"id": "cov_01J7ZWQVSNTKXMEZ77GS81ZG2T",
"name": "Macedonia",
"type": "local",
"created_at": "2024-09-17T11:44:00.818Z",
"updated_at": "2024-10-10T11:44:00.000Z",
"countries": ["MK"
],
"_links": {"self": {"href": "https://api.1global.com/connect/coverage-areas/cov_01J7ZWQVSNTKXMEZ77GS81ZG2T"
}
}
}
}
}
]
},
"_links": {"self": {"href": "https://api.1global.com/connect/product-offerings/prdoff_01HW386JNMYHY5G9VXPNK49ABS"
}
}
},
"balances": [{"type": "limited",
"allowance_type": "data",
"unit": "bytes",
"initial": 524288000,
"remaining": 123000,
"spent": 524165000
}
],
"prices": [{"type": "recurring",
"unit_amount": 50,
"recurrence": {"unit": "month",
"unit_count": 1
},
"currency": "EUR"
}
]
},
"_links": {"self": {"href": "https://api.1global.com/connect/products/prd_01J494WK30DVCMB6ZPYWN21APK"
},
"order": {"href": "https://api.1global.com/connect/orders/ord_01HRCZZKEXG4QSYNVSD6FHFT0D"
},
"subscription": {"href": "https://api.1global.com/connect/subscriptions/subs_01J0BQZ8MZ6C1V8GPYYQC0KZ2S"
}
}
}
}
}

Product Active Webhook

This webhook is triggered when a product is activated.

Authorizations:

basicAuth

Request Body schema: application/hal+json
required

Product active notification payload

id required	string (EventId) <= 100 characters A string that uniquely identifies an Event
type required	string Value: "product.active" The type of notification
created_at required	string <date-time> (Iso8601DateTime) The Date Time format according to the ISO 8601
required	object

Responses

Request samples

Payload

Content type

application/hal+json

{"id": "evt_01J494G6WZAR2E2808Z8M07K4Z",
"type": "product.active",
"created_at": "2021-02-01T14:28:17.967Z",
"data": {"product": {"id": "prd_01J494WK30DVCMB6ZPYWN21APK",
"status": "active",
"created_at": "2023-01-02T08:56:46.944Z",
"started_at": "2023-05-06T16:59:17.967Z",
"end_at": "2023-06-07T16:52:17.967Z",
"expire_at": "2023-08-07T16:52:17.967Z",
"_embedded": {"product_offering": {"id": "prdoff_01HW386JNMYHY5G9VXPNK49ABS",
"name": "Local Macedonia - 15 Days - 70 GB",
"type": "addon",
"validity": {"type": "duration",
"unit": "day",
"unit_count": 15,
"is_recurrent": false
},
"_embedded": {"allowances": [{"type": "data",
"unit": "bytes",
"unit_count": 70,
"is_unlimited": false,
"_embedded": {"coverage_area": {"id": "cov_01J7ZWQVSNTKXMEZ77GS81ZG2T",
"name": "Macedonia",
"type": "local",
"created_at": "2024-09-17T11:44:00.818Z",
"updated_at": "2024-10-10T11:44:00.000Z",
"countries": ["MK"
],
"_links": {"self": {"href": "https://api.1global.com/connect/coverage-areas/cov_01J7ZWQVSNTKXMEZ77GS81ZG2T"
}
}
}
}
}
]
},
"_links": {"self": {"href": "https://api.1global.com/connect/product-offerings/prdoff_01HW386JNMYHY5G9VXPNK49ABS"
}
}
},
"balances": [{"type": "limited",
"allowance_type": "data",
"unit": "bytes",
"initial": 524288000,
"remaining": 123000,
"spent": 524165000
}
],
"prices": [{"type": "recurring",
"unit_amount": 50,
"recurrence": {"unit": "month",
"unit_count": 1
},
"currency": "EUR"
}
]
},
"_links": {"self": {"href": "https://api.1global.com/connect/products/prd_01J494WK30DVCMB6ZPYWN21APK"
},
"order": {"href": "https://api.1global.com/connect/orders/ord_01HRCZZKEXG4QSYNVSD6FHFT0D"
},
"subscription": {"href": "https://api.1global.com/connect/subscriptions/subs_01J0BQZ8MZ6C1V8GPYYQC0KZ2S"
},
"cancel": {"href": "https://api.1global.com/connect/products/prd_01J7ZWP2Q7C2VJRAPW5D62GQEH/cancel"
}
}
}
}
}

Product Canceled Webhook

This webhook is triggered when a product is canceled.

Authorizations:

basicAuth

Request Body schema: application/hal+json
required

Product canceled notification payload

id required	string (EventId) <= 100 characters A string that uniquely identifies an Event
type required	string Value: "product.canceled" The type of notification
created_at required	string <date-time> (Iso8601DateTime) The Date Time format according to the ISO 8601
required	object

Responses

Request samples

Payload

Content type

application/hal+json

{"id": "evt_01J494G6WZAR2E2808Z8M07K4Z",
"type": "product.canceled",
"created_at": "2021-02-01T14:28:17.967Z",
"data": {"product": {"id": "prd_01J494WK30DVCMB6ZPYWN21APK",
"status": "canceled",
"created_at": "2024-09-18T11:57:10.029Z",
"expire_at": "2025-09-18T11:57:08.570Z",
"ended_at": "2024-09-19T12:10:40.218Z",
"_embedded": {"product_offering": {"id": "prdoff_01HW386JNMYHY5G9VXPNK49ABS",
"name": "Local Macedonia - 15 Days - 70 GB",
"type": "addon",
"validity": {"type": "duration",
"unit": "day",
"unit_count": 15,
"is_recurrent": false
},
"_embedded": {"allowances": [{"type": "data",
"unit": "bytes",
"unit_count": 70,
"is_unlimited": false,
"_embedded": {"coverage_area": {"id": "cov_01J7ZWQVSNTKXMEZ77GS81ZG2T",
"name": "Macedonia",
"type": "local",
"created_at": "2024-09-17T11:44:00.818Z",
"updated_at": "2024-10-10T11:44:00.000Z",
"countries": ["MK"
],
"_links": {"self": {"href": "https://api.1global.com/connect/coverage-areas/cov_01J7ZWQVSNTKXMEZ77GS81ZG2T"
}
}
}
}
}
]
},
"_links": {"self": {"href": "https://api.1global.com/connect/product-offerings/prdoff_01HW386JNMYHY5G9VXPNK49ABS"
}
}
},
"balances": [{"type": "limited",
"allowance_type": "data",
"unit": "bytes",
"initial": 524288000,
"remaining": 123000,
"spent": 524165000
}
],
"prices": [{"type": "recurring",
"unit_amount": 50,
"recurrence": {"unit": "month",
"unit_count": 1
},
"currency": "EUR"
}
]
},
"_links": {"self": {"href": "https://api.1global.com/connect/products/prd_01J494WK30DVCMB6ZPYWN21APK"
},
"order": {"href": "https://api.1global.com/connect/orders/ord_01HRCZZKEXG4QSYNVSD6FHFT0D"
},
"subscription": {"href": "https://api.1global.com/connect/subscriptions/subs_01J0BQZ8MZ6C1V8GPYYQC0KZ2S"
}
}
}
}
}

Product Throttling Applied Webhook

This webhook is triggered when a product throttling is applied.

Authorizations:

basicAuth

Request Body schema: application/hal+json
required

Product product throttling applied notification payload

id required	string (EventId) <= 100 characters A string that uniquely identifies an Event
type required	string Value: "product.throttling.applied" The type of notification
created_at required	string <date-time> (Iso8601DateTime) The Date Time format according to the ISO 8601
required	object

Responses

Request samples

Payload

Content type

application/hal+json

{"id": "evt_01J494G6WZAR2E2808Z8M07K4Z",
"type": "product.throttling.applied",
"created_at": "2021-02-01T14:28:17.967Z",
"data": {"throttling": {"bandwidth": "1Mbps",
"period": "daily",
"reset_at": "2025-03-04T15:17:00Z"
},
"product": {"id": "prd_01J806F9TNFYTQM3Z4THPTJEVY",
"status": "active",
"created_at": "2024-09-17T14:34:06.037Z",
"started_at": "2024-09-17T14:35:31.559Z",
"expire_at": "2025-09-17T14:34:03.946Z",
"end_at": "2024-10-17T14:35:31.559Z",
"_embedded": {"product_offering": {"id": "prdoff_01J7ZWQW25H38MHADHDQ21H28W",
"name": "Local Germany 1Month 500MB",
"type": "addon",
"validity": {"type": "duration",
"unit": "month",
"unit_count": 1,
"is_recurrent": false
},
"_embedded": {"allowances": [{"type": "data",
"unit": "megabytes",
"unit_count": 500,
"is_unlimited": false,
"_embedded": {"coverage_area": {"id": "cov_01J7ZWQVSNTKXMEZ77GS81ZG2T",
"name": "Germany",
"type": "local",
"created_at": "2024-09-17T11:44:00.818Z",
"updated_at": "2024-09-17T11:44:00.818Z",
"countries": ["DE"
],
"_links": {"self": {"href": "https://api.1global.com/connect/coverage-areas/cov_01J7ZWQVSNTKXMEZ77GS81ZG2T"
}
}
}
}
}
]
},
"_links": {"self": {"href": "https://api.1global.com/connect/product-offerings/prdoff_01J7ZWQW25H38MHADHDQ21H28W"
}
}
},
"balances": [{"type": "limited",
"allowance_type": "data",
"unit": "bytes",
"initial": 524288000,
"remaining": 123000,
"spent": 524165000
}
],
"prices": [{"type": "one_time",
"unit_amount": 0,
"currency": "EUR"
}
]
},
"_links": {"self": {"href": "https://api.1global.com/connect/products/prd_01J806F9TNFYTQM3Z4THPTJEVY"
},
"cancel": {"href": "https://api.1global.com/connect/products/prd_01J806F9TNFYTQM3Z4THPTJEVY/cancel"
},
"order": {"href": "https://api.1global.com/connect/orders/ord_01J806F7RDT6ERDN47MHPC6AA2"
},
"subscription": {"href": "https://api.1global.com/connect/subscriptions/subs_01J806F86A8YJDPDX0DY9ZM7TD"
}
}
}
}
}

Subscription Active Webhook

This webhook is triggered when a subscription is activated.

Authorizations:

basicAuth

Request Body schema: application/hal+json
required

Subscription active event payload

id required	string (EventId) <= 100 characters A string that uniquely identifies an Event
type required	string Value: "subscription.active" The type of notification
created_at required	string <date-time> (Iso8601DateTime) The Date Time format according to the ISO 8601
required	object

Responses

Request samples

Payload

Content type

application/hal+json

{"id": "evt_01J494G6WZAR2E2808Z8M07K4Z",
"type": "subscription.active",
"created_at": "2021-02-01T14:28:17.967Z",
"data": {"subscription": {"id": "subs_01BX5ZZKBKACTAV9WEVGEMMVRY",
"status": "active",
"created_at": "2023-01-01T00:00:00.100Z",
"updated_at": "2023-05-21T00:00:00.500Z",
"_embedded": {"sim_profile": {"iccid": "8988211234567890123",
"sim_type": "esim",
"profile_status": "ready_for_installation",
"matching_id": "5C-ZYXZZ-1R54O94",
"smdp_address": "rsp.truphone.com",
"_embedded": {"device": {"uicc": {"eid": "89049032004008882600018948798950"
}
}
}
},
"active_phone_numbers": [{"id": "pn_01BX5ZZKBKACTAV9WEVGEMUIJ6",
"status": "active",
"created_at": "2024-01-01T00:00:00.100Z",
"updated_at": "2024-05-21T00:00:00.500Z",
"msisdn": "+4912984900817",
"country": "DE",
"is_primary": true,
"_links": {"self": {"href": "https://api.1global.com/connect/phone-numbers/pn_01BX5ZZKBKACTAV9WEVGEMUIJ6"
},
"enable-porting-opt-in": {"href": "https://api.1global.com/connect/phone-numbers/pn_01BX5ZZKBKACTAV9WEVGEMUIJ6/enable-porting-opt-in"
},
"disable-porting-opt-in": {"href": "https://api.1global.com/connect/phone-numbers/pn_01BX5ZZKBKACTAV9WEVGEMUIJ6/disable-porting-opt-in"
}
}
}
],
"account": {"id": "acc_01HRC2T6WK4CMVGFXA2RESTQ97",
"_links": {"self": {"href": "http://api.1global.com/connect/accounts/acc_01HRC2T6WK4CMVGFXA2RESTQ97"
}
}
}
},
"_links": {"self": {"href": "http://api.1global.com/connect/subscriptions/subs_01BX5ZZKBKACTAV9WEVGEMMVRY"
},
"subscriber": {"href": "http://api.1global.com/connect/subscriber/subr_02BX5ZZKBKACTAV9WEVGEMMVRY"
},
"products": {"href": "http://api.1global.com/connect/products?subscription=subs_01BX5ZZKBKACTAV9WEVGEMMVRY"
},
"qrcode": {"href": "http://api.1global.com/qrcode/v1/esim/LPA:1$rsp.truphone.com$5C-ZYXZZ-1R54O94"
},
"grace": {"href": "http://api.1global.com/connect/subscriptions/subs_01BX5ZZKBKACTAV9WEVGEMMVRY/grace"
},
"suspend": {"href": "http://api.1global.com/connect/subscriptions/subs_01BX5ZZKBKACTAV9WEVGEMMVRY/suspend"
},
"deactivate": {"href": "http://api.1global.com/connect/subscriptions/subs_01BX5ZZKBKACTAV9WEVGEMMVRY/deactivate"
},
"cancel": {"href": "http://api.1global.com/connect/subscriptions/subs_01BX5ZZKBKACTAV9WEVGEMMVRY/cancel"
}
}
}
}
}

Subscription Grace Webhook

This webhook is triggered when a subscription goes into grace period.

Authorizations:

basicAuth

Request Body schema: application/hal+json
required

Subscription grace event payload

id required	string (EventId) <= 100 characters A string that uniquely identifies an Event
type required	string Value: "subscription.grace" The type of notification
created_at required	string <date-time> (Iso8601DateTime) The Date Time format according to the ISO 8601
required	object

Responses

Request samples

Payload

Content type

application/hal+json

{"id": "evt_01J494G6WZAR2E2808Z8M07K4Z",
"type": "subscription.grace",
"created_at": "2021-02-01T14:28:17.967Z",
"data": {"subscription": {"id": "subs_01BX5ZZKBKACTAV9WEVGEMMVRY",
"status": "grace",
"created_at": "2023-01-01T00:00:00.100Z",
"updated_at": "2023-05-21T00:00:00.500Z",
"_embedded": {"sim_profile": {"iccid": "8988211234567890123",
"sim_type": "esim",
"profile_status": "installed",
"matching_id": "5C-ZYXZZ-1R54O94",
"smdp_address": "rsp.truphone.com",
"_embedded": {"device": {"uicc": {"eid": "89049032004008882600018948798950"
}
}
}
},
"active_phone_numbers": [{"id": "pn_01BX5ZZKBKACTAV9WEVGEMUIJ6",
"status": "active",
"created_at": "2024-01-01T00:00:00.100Z",
"updated_at": "2024-05-21T00:00:00.500Z",
"msisdn": "+4912984900817",
"country": "DE",
"is_primary": true,
"_links": {"self": {"href": "https://api.1global.com/connect/phone-numbers/pn_01BX5ZZKBKACTAV9WEVGEMUIJ6"
},
"enable-porting-opt-in": {"href": "https://api.1global.com/connect/phone-numbers/pn_01BX5ZZKBKACTAV9WEVGEMUIJ6/enable-porting-opt-in"
},
"disable-porting-opt-in": {"href": "https://api.1global.com/connect/phone-numbers/pn_01BX5ZZKBKACTAV9WEVGEMUIJ6/disable-porting-opt-in"
}
}
}
],
"account": {"id": "acc_01HRC2T6WK4CMVGFXA2RESTQ97",
"_links": {"self": {"href": "http://api.1global.com/connect/accounts/acc_01HRC2T6WK4CMVGFXA2RESTQ97"
}
}
}
},
"_links": {"self": {"href": "http://api.1global.com/connect/subscriptions/subs_01BX5ZZKBKACTAV9WEVGEMMVRY"
},
"subscriber": {"href": "http://api.1global.com/connect/subscriber/subr_02BX5ZZKBKACTAV9WEVGEMMVRY"
},
"products": {"href": "http://api.1global.com/connect/products?subscription=subs_01BX5ZZKBKACTAV9WEVGEMMVRY"
},
"qrcode": {"href": "http://api.1global.com/qrcode/v1/esim/LPA:1$rsp.truphone.com$5C-ZYXZZ-1R54O94"
},
"suspend": {"href": "http://api.1global.com/connect/subscriptions/subs_01BX5ZZKBKACTAV9WEVGEMMVRY/suspend"
},
"cancel": {"href": "http://api.1global.com/connect/subscriptions/subs_01BX5ZZKBKACTAV9WEVGEMMVRY/cancel"
}
}
}
}
}

Subscription Suspended Webhook

This webhook is triggered when a subscription is suspended.

Authorizations:

basicAuth

Request Body schema: application/hal+json
required

Subscription suspended event payload

id required	string (EventId) <= 100 characters A string that uniquely identifies an Event
type required	string Value: "subscription.suspended" The type of notification
created_at required	string <date-time> (Iso8601DateTime) The Date Time format according to the ISO 8601
required	object

Responses

Request samples

Payload

Content type

application/hal+json

{"id": "evt_01J494G6WZAR2E2808Z8M07K4Z",
"type": "subscription.suspended",
"created_at": "2021-02-01T14:28:17.967Z",
"data": {"subscription": {"id": "subs_01BX5ZZKBKACTAV9WEVGEMMVRY",
"status": "suspended",
"created_at": "2023-01-01T00:00:00.100Z",
"updated_at": "2023-05-21T00:00:00.500Z",
"_embedded": {"sim_profile": {"iccid": "8988211234567890123",
"sim_type": "esim",
"profile_status": "installed",
"matching_id": "5C-ZYXZZ-1R54O94",
"smdp_address": "rsp.truphone.com",
"_embedded": {"device": {"uicc": {"eid": "89049032004008882600018948798950"
}
}
}
},
"active_phone_numbers": [{"id": "pn_01BX5ZZKBKACTAV9WEVGEMUIJ6",
"status": "active",
"created_at": "2024-01-01T00:00:00.100Z",
"updated_at": "2024-05-21T00:00:00.500Z",
"msisdn": "+4912984900817",
"country": "DE",
"is_primary": true,
"_links": {"self": {"href": "https://api.1global.com/connect/phone-numbers/pn_01BX5ZZKBKACTAV9WEVGEMUIJ6"
},
"enable-porting-opt-in": {"href": "https://api.1global.com/connect/phone-numbers/pn_01BX5ZZKBKACTAV9WEVGEMUIJ6/enable-porting-opt-in"
},
"disable-porting-opt-in": {"href": "https://api.1global.com/connect/phone-numbers/pn_01BX5ZZKBKACTAV9WEVGEMUIJ6/disable-porting-opt-in"
}
}
}
],
"account": {"id": "acc_01HRC2T6WK4CMVGFXA2RESTQ97",
"_links": {"self": {"href": "http://api.1global.com/connect/accounts/acc_01HRC2T6WK4CMVGFXA2RESTQ97"
}
}
}
},
"_links": {"self": {"href": "http://api.1global.com/connect/subscriptions/subs_01BX5ZZKBKACTAV9WEVGEMMVRY"
},
"subscriber": {"href": "http://api.1global.com/connect/subscriber/subr_02BX5ZZKBKACTAV9WEVGEMMVRY"
},
"products": {"href": "http://api.1global.com/connect/products?subscription=subs_01BX5ZZKBKACTAV9WEVGEMMVRY"
},
"qrcode": {"href": "http://api.1global.com/qrcode/v1/esim/LPA:1$rsp.truphone.com$5C-ZYXZZ-1R54O94"
},
"cancel": {"href": "http://api.1global.com/connect/subscriptions/subs_01BX5ZZKBKACTAV9WEVGEMMVRY/cancel"
}
}
}
}
}

Subscription Terminated Webhook

This webhook is triggered when a subscription is terminated.

Authorizations:

basicAuth

Request Body schema: application/hal+json
required

Subscription terminated event payload

id required	string (EventId) <= 100 characters A string that uniquely identifies an Event
type required	string Value: "subscription.terminated" The type of notification
created_at required	string <date-time> (Iso8601DateTime) The Date Time format according to the ISO 8601
required	object

Responses

Request samples

Payload

Content type

application/hal+json

{"id": "evt_01J494G6WZAR2E2808Z8M07K4Z",
"type": "subscription.terminated",
"created_at": "2021-02-01T14:28:17.967Z",
"data": {"subscription": {"id": "subs_01BX5ZZKBKACTAV9WEVGEMMVRY",
"status": "terminated",
"created_at": "2023-01-01T00:00:00Z",
"updated_at": "2023-05-21T00:00:00Z",
"_embedded": {"sim_profile": {"iccid": "8988211234567890123",
"sim_type": "esim",
"profile_status": "ready_for_installation",
"matching_id": "5C-ZYXZZ-1R54O94",
"smdp_address": "rsp.truphone.com",
"_embedded": {"device": {"uicc": {"eid": "89049032004008882600018948798950"
}
}
}
},
"account": {"id": "acc_01HRC2T6WK4CMVGFXA2RESTQ97",
"_links": {"self": {"href": "http://api.1global.com/connect/accounts/acc_01HRC2T6WK4CMVGFXA2RESTQ97"
}
}
}
},
"_links": {"self": {"href": "http://api.1global.com/connect/subscriptions/subs_01BX5ZZKBKACTAV9WEVGEMMVRY"
},
"subscriber": {"href": "http://api.1global.com/connect/subscriber/subr_02BX5ZZKBKACTAV9WEVGEMMVRY"
},
"products": {"href": "http://api.1global.com/connect/products?subscription=subs_01BX5ZZKBKACTAV9WEVGEMMVRY"
}
}
}
}
}

Subscription Deactivated Webhook

This webhook is triggered when a subscription is deactivated.

Authorizations:

basicAuth

Request Body schema: application/hal+json
required

Subscription deactivated event payload

id required	string (EventId) <= 100 characters A string that uniquely identifies an Event
type required	string Value: "subscription.deactivated" The type of notification
created_at required	string <date-time> (Iso8601DateTime) The Date Time format according to the ISO 8601
required	object

Responses

Request samples

Payload

Content type

application/hal+json

{"id": "evt_01J494G6WZAR2E2808Z8M07K4Z",
"type": "subscription.deactivated",
"created_at": "2021-02-01T14:28:17.967Z",
"data": {"subscription": {"id": "subs_01BX5ZZKBKACTAV9WEVGEMMVRY",
"status": "deactivated",
"created_at": "2023-01-01T00:00:00.100Z",
"updated_at": "2023-05-21T00:00:00.500Z",
"_embedded": {"sim_profile": {"iccid": "8988211234567890123",
"sim_type": "esim",
"profile_status": "installed",
"matching_id": "5C-ZYXZZ-1R54O94",
"smdp_address": "rsp.truphone.com",
"_embedded": {"device": {"uicc": {"eid": "89049032004008882600018948798950"
}
}
}
},
"active_phone_numbers": [{"id": "pn_01BX5ZZKBKACTAV9WEVGEMUIJ6",
"status": "active",
"created_at": "2024-01-01T00:00:00.100Z",
"updated_at": "2024-05-21T00:00:00.500Z",
"msisdn": "+49112984900817",
"country": "DE",
"is_primary": true,
"_links": {"self": {"href": "https://api.1global.com/connect/phone-numbers/pn_01BX5ZZKBKACTAV9WEVGEMUIJ6"
},
"enable-porting-opt-in": {"href": "https://api.1global.com/connect/phone-numbers/pn_01BX5ZZKBKACTAV9WEVGEMUIJ6/enable-porting-opt-in"
},
"disable-porting-opt-in": {"href": "https://api.1global.com/connect/phone-numbers/pn_01BX5ZZKBKACTAV9WEVGEMUIJ6/disable-porting-opt-in"
}
}
}
],
"account": {"id": "acc_01HRC2T6WK4CMVGFXA2RESTQ97",
"_links": {"self": {"href": "http://api.1global.com/connect/accounts/acc_01HRC2T6WK4CMVGFXA2RESTQ97"
}
}
}
},
"_links": {"self": {"href": "http://api.1global.com/connect/subscriptions/subs_01BX5ZZKBKACTAV9WEVGEMMVRY"
},
"subscriber": {"href": "http://api.1global.com/connect/subscriber/subr_02BX5ZZKBKACTAV9WEVGEMMVRY"
},
"products": {"href": "http://api.1global.com/connect/products?subscription=subs_01BX5ZZKBKACTAV9WEVGEMMVRY"
},
"resume": {"href": "http://api.1global.com/connect/subscriptions/subs_01BX5ZZKBKACTAV9WEVGEMMVRY/resume"
},
"cancel": {"href": "http://api.1global.com/connect/subscriptions/subs_01BX5ZZKBKACTAV9WEVGEMMVRY/cancel"
}
}
}
}
}

Subscription Canceled Webhook

This webhook is triggered when a subscription is canceled.

Authorizations:

basicAuth

Request Body schema: application/hal+json
required

Subscription canceled event payload

id required	string (EventId) <= 100 characters A string that uniquely identifies an Event
type required	string Value: "subscription.canceled" The type of notification
created_at required	string <date-time> (Iso8601DateTime) The Date Time format according to the ISO 8601
required	object

Responses

Request samples

Payload

Content type

application/hal+json

{"id": "evt_01J494G6WZAR2E2808Z8M07K4Z",
"type": "subscription.canceled",
"created_at": "2021-02-01T14:28:17.967Z",
"data": {"subscription": {"id": "subs_01BX5ZZKBKACTAV9WEVGEMMVRY",
"status": "canceled",
"created_at": "2023-01-01T00:00:00.100Z",
"updated_at": "2023-05-21T00:00:00.500Z",
"_embedded": {"sim_profile": {"iccid": "8988211234567890123",
"sim_type": "esim",
"profile_status": "installed",
"matching_id": "5C-ZYXZZ-1R54O94",
"smdp_address": "rsp.truphone.com",
"_embedded": {"device": {"uicc": {"eid": "89049032004008882600018948798950"
}
}
}
},
"active_phone_numbers": [{"id": "pn_01BX5ZZKBKACTAV9WEVGEMUIJ6",
"status": "active",
"created_at": "2024-01-01T00:00:00.100Z",
"updated_at": "2024-05-21T00:00:00.500Z",
"msisdn": "+4912984900817",
"country": "DE",
"is_primary": true,
"_links": {"self": {"href": "https://api.1global.com/connect/phone-numbers/pn_01BX5ZZKBKACTAV9WEVGEMUIJ6"
},
"enable-porting-opt-in": {"href": "https://api.1global.com/connect/phone-numbers/pn_01BX5ZZKBKACTAV9WEVGEMUIJ6/enable-porting-opt-in"
},
"disable-porting-opt-in": {"href": "https://api.1global.com/connect/phone-numbers/pn_01BX5ZZKBKACTAV9WEVGEMUIJ6/disable-porting-opt-in"
}
}
}
],
"account": {"id": "acc_01HRC2T6WK4CMVGFXA2RESTQ97",
"_links": {"self": {"href": "http://api.1global.com/connect/accounts/acc_01HRC2T6WK4CMVGFXA2RESTQ97"
}
}
}
},
"_links": {"self": {"href": "http://api.1global.com/connect/subscriptions/subs_01BX5ZZKBKACTAV9WEVGEMMVRY"
},
"subscriber": {"href": "http://api.1global.com/connect/subscriber/subr_02BX5ZZKBKACTAV9WEVGEMMVRY"
},
"products": {"href": "http://api.1global.com/connect/products?subscription=subs_01BX5ZZKBKACTAV9WEVGEMMVRY"
}
}
}
}
}

Subscription Profile Installed Webhook

This webhook is triggered when a profile is installed.

Authorizations:

basicAuth

Request Body schema: application/hal+json
required

Subscription profile event payload

id required	string (EventId) <= 100 characters A string that uniquely identifies an Event
type required	string Value: "subscription.sim_profile.installed" The type of notification
created_at required	string <date-time> (Iso8601DateTime) The Date Time format according to the ISO 8601
required	object

Responses

Request samples

Payload

Content type

application/hal+json

{"id": "evt_01J494G6WZAR2E2808Z8M07K4Z",
"type": "subscription.sim_profile.installed",
"created_at": "2021-02-01T14:28:17.967Z",
"data": {"subscription": {"id": "subs_01J3YVZN6DGMG6BWYJ8QY8NZ1H",
"status": "active",
"created_at": "2024-07-29T09:08:45.901Z",
"updated_at": "2024-07-29T09:08:45.984Z",
"_embedded": {"sim_profile": {"sim_type": "esim",
"profile_status": "Installed",
"matching_id": "BR-24GGSR-11KEFFV",
"smdp_address": "rsp.truphone.com",
"iccid": "8999999999990238017",
"_embedded": {"device": {"uicc": {"eid": "89049032004008882600018948798950"
}
}
}
},
"account": {"id": "acc_01HRC2T6WK4CMVGFXA2RESTQ97",
"_links": {"self": {"href": "http://api.1global.com/connect/accounts/acc_01HRC2T6WK4CMVGFXA2RESTQ97"
}
}
}
},
"_links": {"self": {"href": "http://api.1global.com/connect/subscriptions/evt_01J494G6WZAR2E2808Z8M07K4Z"
},
"qrcode": {"href": "http://api.1global.com/qrcode/v1/esim/LPA:1$rsp.truphone.com$BR-24GGSR-11KEFFV"
},
"products": {"href": "http://api.1global.com/connect/products?subscription=evt_01J494G6WZAR2E2808Z8M07K4Z"
},
"subscriber": {"href": "http://api.1global.com/connect/subscriber/subr_02BX5ZZKBKACTAV9WEVGEMMVRY"
}
}
}
}
}

Subscription Profile Deleted Webhook

This webhook is triggered when a profile is deleted.

Authorizations:

basicAuth

Request Body schema: application/hal+json
required

Subscription profile event payload

id required	string (EventId) <= 100 characters A string that uniquely identifies an Event
type required	string Value: "subscription.sim_profile.deleted" The type of notification
created_at required	string <date-time> (Iso8601DateTime) The Date Time format according to the ISO 8601
required	object

Responses

Request samples

Payload

Content type

application/hal+json

{"id": "evt_01J494G6WZAR2E2808Z8M07K4Z",
"type": "subscription.sim_profile.deleted",
"created_at": "2021-02-01T14:28:17.967Z",
"data": {"subscription": {"id": "subs_01J3YVZN6DGMG6BWYJ8QY8NZ1H",
"status": "terminated",
"created_at": "2024-07-29T09:08:45.901Z",
"updated_at": "2024-07-29T09:08:45.984Z",
"_embedded": {"sim_profile": {"sim_type": "esim",
"profile_status": "Deleted",
"matching_id": "BR-24GGSR-11KEFFV",
"smdp_address": "rsp.truphone.com",
"iccid": "8999999999990238017",
"_embedded": {"device": {"uicc": {"eid": "89049032004008882600018948798950"
}
}
}
},
"account": {"id": "acc_01HRC2T6WK4CMVGFXA2RESTQ97",
"_links": {"self": {"href": "http://api.1global.com/connect/accounts/acc_01HRC2T6WK4CMVGFXA2RESTQ97"
}
}
}
},
"_links": {"self": {"href": "http://api.1global.com/connect/subscriptions/subs_01J3YVZN6DGMG6BWYJ8QY8NZ1H"
},
"qrcode": {"href": "http://api.1global.com/qrcode/v1/esim/LPA:1$rsp.truphone.com$BR-24GGSR-11KEFFV"
},
"products": {"href": "http://api.1global.com/connect/products?subscription=subs_01J3YVZN6DGMG6BWYJ8QY8NZ1H"
},
"subscriber": {"href": "http://api.1global.com/connect/subscriber/subr_02BX5ZZKBKACTAV9WEVGEMMVRY"
}
}
}
}
}

Subscription Profile Ready for Installation Webhook

This webhook is triggered when a profile is ready for installed.

Authorizations:

basicAuth

Request Body schema: application/hal+json
required

Subscription profile event payload

id required	string (EventId) <= 100 characters A string that uniquely identifies an Event
type required	string Value: "subscription.sim_profile.ready_for_installation" The type of notification
created_at required	string <date-time> (Iso8601DateTime) The Date Time format according to the ISO 8601
required	object

Responses

Request samples

Payload

Content type

application/hal+json

{"id": "evt_01J494G6WZAR2E2808Z8M07K4Z",
"type": "subscription.sim_profile.ready_for_installation",
"created_at": "2021-02-01T14:28:17.967Z",
"data": {"subscription": {"id": "subs_01J3YVZN6DGMG6BWYJ8QY8NZ1H",
"status": "active",
"created_at": "2024-07-29T09:08:45.901Z",
"updated_at": "2024-07-29T09:08:45.984Z",
"_embedded": {"sim_profile": {"sim_type": "esim",
"profile_status": "ready_for_installation",
"matching_id": "BR-24GGSR-11KEFFV",
"smdp_address": "rsp.truphone.com",
"iccid": "8999999999990238017",
"_embedded": {"device": {"uicc": {"eid": "89049032004008882600018948798950"
}
}
}
},
"account": {"id": "acc_01HRC2T6WK4CMVGFXA2RESTQ97",
"_links": {"self": {"href": "http://api.1global.com/connect/accounts/acc_01HRC2T6WK4CMVGFXA2RESTQ97"
}
}
}
},
"_links": {"self": {"href": "http://api.1global.com/connect/subscriptions/evt_01J494G6WZAR2E2808Z8M07K4Z"
},
"qrcode": {"href": "http://api.1global.com/qrcode/v1/esim/LPA:1$rsp.truphone.com$BR-24GGSR-11KEFFV"
},
"products": {"href": "http://api.1global.com/connect/products?subscription=evt_01J494G6WZAR2E2808Z8M07K4Z"
},
"subscriber": {"href": "http://api.1global.com/connect/subscriber/subr_02BX5ZZKBKACTAV9WEVGEMMVRY"
}
}
},
"order": {"id": "ord_01J7ZWP1X8MBE7GZ73M75JEPB2",
"_links": {"self": {"href": "http://api.1global.com/connect/orders/ord_01J7ZWP1X8MBE7GZ73M75JEPB2"
}
}
}
}
}

Order Completed Webhook

This webhook is triggered when an order is completed.

Authorizations:

basicAuth

Request Body schema: application/hal+json
required

Order completed notification payload

id required	string (EventId) <= 100 characters A string that uniquely identifies an Event
type required	string Value: "order.completed" The type of notification
created_at required	string <date-time> (Iso8601DateTime) The Date Time format according to the ISO 8601
required	object

Responses

Request samples

Payload

Content type

application/hal+json

{"id": "evt_01J494G6WZAR2E2808Z8M07K4Z",
"type": "order.completed",
"created_at": "2024-08-08T14:28:17.967Z",
"data": {"order": {"id": "ord_01HV3KWPNRCT870WV3XG41CAT3",
"status": "completed",
"type": "activate_subscription",
"created_at": "2024-08-02T09:13:28.384Z",
"updated_at": "2024-08-02T09:13:40.544Z",
"completed_at": "2024-08-02T09:15:30.544Z",
"_embedded": {"subscription": {"id": "subs_01HRCZZWCBXR40JQ6B705952WJ",
"status": "active",
"created_at": "2024-07-11T10:29:42.426Z",
"updated_at": "2024-07-11T10:29:42.426Z",
"_embedded": {"sim_profile": {"iccid": "8988211234567890023",
"sim_type": "esim",
"profile_status": "ready_for_installation",
"matching_id": "5C-ZYXZZ-1R54O94",
"smdp_address": "rsp.truphone.com",
"_embedded": {"device": {"uicc": {"eid": "89049032007208882600182092769530"
}
}
}
},
"account": {"id": "acc_01HRC2T6WK4CMVGFXA2RESTQ97",
"_links": {"self": {"href": "http://api.1global.com/connect/accounts/acc_01HRC2T6WK4CMVGFXA2RESTQ97"
}
}
}
},
"_links": {"self": {"href": "https://api.1global.com/connect/subscriptions/subs_01HRCZZWCBXR40JQ6B705952WJ"
},
"qrcode": {"href": "https://api.1global.com/connect/qrcode/v1/esim/LPA:1$rsp.truphone.com$5C-ZYXZZ-1R54O94"
}
}
}
},
"_links": {"self": {"href": "https://api.1global.com/connect/orders/ord_01HV3KWPNRCT870WV3XG41CAT3"
},
"subscriber": {"href": "http://api.1global.com/connect/subscriber/subr_02BX5ZZKBKACTAV9WEVGEMMVRY"
}
}
}
}
}

Order Failed Webhook

This webhook is triggered when an order has failed.

Authorizations:

basicAuth

Request Body schema: application/hal+json
required

Order failed notification payload

id required	string (EventId) <= 100 characters A string that uniquely identifies an Event
type required	string Value: "order.failed" The type of notification
created_at required	string <date-time> (Iso8601DateTime) The Date Time format according to the ISO 8601
required	object

Responses

Request samples

Payload

Content type

application/hal+json

{"id": "evt_01J494G6WZAR2E2808Z8M07K4Z",
"type": "order.failed",
"created_at": "2024-08-08T14:28:17.967Z",
"data": {"order": {"id": "ord_01HV3KWPNRCT870WV3XG41CAT3",
"status": "failed",
"type": "activate_subscription",
"created_at": "2024-08-02T09:13:28.384Z",
"updated_at": "2024-08-02T09:13:40.544Z",
"completed_at": "2024-08-02T09:15:30.544Z",
"_embedded": {"subscription": {"id": "subs_01HRCZZWCBXR40JQ6B705952WJ",
"status": "active",
"created_at": "2024-07-11T10:29:42.426Z",
"updated_at": "2024-07-11T10:29:42.426Z",
"_embedded": {"sim_profile": {"iccid": "8988211234567890023",
"sim_type": "esim",
"profile_status": "ready_for_installation",
"matching_id": "5C-ZYXZZ-1R54O94",
"smdp_address": "rsp.truphone.com",
"_embedded": {"device": {"uicc": {"eid": "89049032007208882600182092769530"
}
}
}
},
"account": {"id": "acc_01HRC2T6WK4CMVGFXA2RESTQ97",
"_links": {"self": {"href": "http://api.1global.com/connect/accounts/acc_01HRC2T6WK4CMVGFXA2RESTQ97"
}
}
}
},
"_links": {"self": {"href": "https://api.1global.com/connect/subscriptions/subs_01HRCZZWCBXR40JQ6B705952WJ"
},
"qrcode": {"href": "https://api.1global.com/connect/qrcode/v1/esim/LPA:1$rsp.truphone.com$5C-ZYXZZ-1R54O94"
}
}
}
},
"_links": {"self": {"href": "https://api.1global.com/connect/orders/ord_01HV3KWPNRCT870WV3XG41CAT3"
},
"subscriber": {"href": "http://api.1global.com/connect/subscriber/subr_02BX5ZZKBKACTAV9WEVGEMMVRY"
}
}
}
}
}

Porting Draft Webhook

This webhook is triggered when a porting request is in draft

Authorizations:

basicAuth

Request Body schema: application/hal+json
required

Porting draft event schema

id required	string (EventId) <= 100 characters A string that uniquely identifies an Event
type required	string Value: "porting.draft" The type of notification
created_at required	string <date-time> (Iso8601DateTime) The Date Time format according to the ISO 8601
required	object

Responses

Request samples

Payload

Content type

application/hal+json

{"id": "evt_01J494G6WZAR2E2808Z8M07K4Z",
"type": "porting.draft",
"created_at": "2021-02-01T14:28:17.967Z",
"data": {"porting": {"id": "port_01J6HE2DP5M8GKQ9P8R83VQW3J",
"direction": "in",
"preferred_schedule": {"type": "specific_date",
"preferred_porting_at": "2024-08-30T10:42:34.309Z"
},
"country": "DE",
"status": "draft",
"msisdn": "+4912341234123",
"donor_details": {"_embedded": {"network_operator": {"id": "nopr_01J6795M195EXEECTPY9Y3QD66",
"name": "Operator Name",
"trade_name": "Trade Operator Name",
"country": "DE",
"status": "active",
"created_at": "2024-08-30T10:42:34.309Z",
"updated_at": "2024-08-30T10:42:34.309Z",
"_links": {"self": {"href": "https://api.1global.com/connect/network-operators/nopr_01J6795M195EXEECTPY9Y3QD66"
}
}
},
"service_provider": {"id": "spro_01J6795M195EXEECTPY9Y3QD66",
"name": "Provider Name",
"country": "DE",
"status": "active",
"created_at": "2024-08-30T10:42:34.309Z",
"updated_at": "2024-08-30T10:42:34.309Z",
"_links": {"self": {"href": "https://api.1global.com/connect/service-providers/spro_01J6795M195EXEECTPY9Y3QD66"
}
}
}
},
"account": {"type": "personal"
}
},
"created_at": "2024-08-30T10:42:34.309Z",
"updated_at": "2024-08-30T10:42:34.309Z",
"_links": {"self": {"href": "https://api.1global.com/connect/portings/port_01J6HE2DP5M8GKQ9P8R83VQW3J"
},
"account": {"href": "https://api.1global.com/connect/acounts/acc_01J6795M195EXEECTPY9Y3QD66"
},
"subscriber": {"href": "https://api.1global.com/connect/subscriber/subr_01J67F1GGCN0ZMGJQ17NTYV3WV"
},
"subscription": {"href": "https://api.1global.com/connect/subscriptions/subs_01J67SMMCM050XM1C1ABQNFD9K"
},
"phone_number": {"href": "https://api.1global.com/connect/phone-numbers/pn_01J6795M195EXEECTPY9Y3QD66"
}
}
}
}
}

Porting Pending Webhook

This webhook is triggered when a porting request is in pending

Authorizations:

basicAuth

Request Body schema: application/hal+json
required

Porting pending event schema

One of

id required	string (EventId) <= 100 characters A string that uniquely identifies an Event
type required	string Value: "porting.pending" The type of notification
created_at required	string <date-time> (Iso8601DateTime) The Date Time format according to the ISO 8601
required	object

Responses

Request samples

Payload

Content type

application/hal+json

Example

Porting Port-In Pending Example

{"id": "evt_01J494G6WZAR2E2808Z8M07K4Z",
"type": "porting.pending",
"created_at": "2021-02-01T14:28:17.967Z",
"data": {"porting": {"id": "port_01J6HE2DP5M8GKQ9P8R83VQW3J",
"direction": "in",
"preferred_schedule": {"type": "specific_date",
"preferred_porting_at": "2024-08-30T10:42:34.309Z"
},
"country": "DE",
"status": "pending",
"msisdn": "+4912341234123",
"donor_details": {"_embedded": {"network_operator": {"id": "nopr_01J6795M195EXEECTPY9Y3QD66",
"name": "Operator Name",
"trade_name": "Trade Operator Name",
"country": "DE",
"status": "active",
"created_at": "2024-08-30T10:42:34.309Z",
"updated_at": "2024-08-30T10:42:34.309Z",
"_links": {"self": {"href": "https://api.1global.com/connect/network-operators/nopr_01J6795M195EXEECTPY9Y3QD66"
}
}
},
"service_provider": {"id": "spro_01J6795M195EXEECTPY9Y3QD66",
"name": "Provider Name",
"country": "DE",
"status": "active",
"created_at": "2024-08-30T10:42:34.309Z",
"updated_at": "2024-08-30T10:42:34.309Z",
"_links": {"self": {"href": "https://api.1global.com/connect/service-providers/spro_01J6795M195EXEECTPY9Y3QD66"
}
}
}
},
"account": {"type": "personal"
}
},
"created_at": "2024-08-30T10:42:34.309Z",
"updated_at": "2024-08-30T10:42:34.309Z",
"_links": {"self": {"href": "https://api.1global.com/connect/portings/port_01J6HE2DP5M8GKQ9P8R83VQW3J"
},
"account": {"href": "https://api.1global.com/connect/acounts/acc_01J6795M195EXEECTPY9Y3QD66"
},
"subscriber": {"href": "https://api.1global.com/connect/subscriber/subr_01J67F1GGCN0ZMGJQ17NTYV3WV"
},
"subscription": {"href": "https://api.1global.com/connect/subscriptions/subs_01J67SMMCM050XM1C1ABQNFD9K"
},
"phone_number": {"href": "https://api.1global.com/connect/phone-numbers/pn_01J6795M195EXEECTPY9Y3QD66"
}
}
}
}
}

Porting Scheduled Webhook

This webhook is triggered when a porting request is in Scheduled

Authorizations:

basicAuth

Request Body schema: application/hal+json
required

Porting draft event schema

One of

id required	string (EventId) <= 100 characters A string that uniquely identifies an Event
type required	string Value: "porting.scheduled" The type of notification
created_at required	string <date-time> (Iso8601DateTime) The Date Time format according to the ISO 8601
required	object

Responses

Request samples

Payload

Content type

application/hal+json

Example

Porting Port-In Scheduled Example

{"id": "evt_01J494G6WZAR2E2808Z8M07K4Z",
"type": "porting.scheduled",
"created_at": "2021-02-01T14:28:17.967Z",
"data": {"porting": {"id": "port_01J6HE2DP5M8GKQ9P8R83VQW3J",
"direction": "in",
"preferred_schedule": {"type": "specific_date",
"preferred_porting_at": "2024-08-30T10:42:34.309Z"
},
"country": "DE",
"status": "scheduled",
"msisdn": "+4912341234123",
"donor_details": {"_embedded": {"network_operator": {"id": "nopr_01J6795M195EXEECTPY9Y3QD66",
"name": "Operator Name",
"trade_name": "Trade Operator Name",
"country": "DE",
"status": "active",
"created_at": "2024-08-30T10:42:34.309Z",
"updated_at": "2024-08-30T10:42:34.309Z",
"_links": {"self": {"href": "https://api.1global.com/connect/network-operators/nopr_01J6795M195EXEECTPY9Y3QD66"
}
}
},
"service_provider": {"id": "spro_01J6795M195EXEECTPY9Y3QD66",
"name": "Provider Name",
"country": "DE",
"status": "active",
"created_at": "2024-08-30T10:42:34.309Z",
"updated_at": "2024-08-30T10:42:34.309Z",
"_links": {"self": {"href": "https://api.1global.com/connect/service-providers/spro_01J6795M195EXEECTPY9Y3QD66"
}
}
}
},
"account": {"type": "personal"
}
},
"cancelation_deadline_at": "2024-10-01T14:28:17.456Z",
"scheduled_at": "2024-10-01T14:28:17.456Z",
"created_at": "2024-08-30T10:42:34.309Z",
"updated_at": "2024-08-30T10:42:34.309Z",
"_links": {"self": {"href": "https://api.1global.com/connect/portings/port_01J6HE2DP5M8GKQ9P8R83VQW3J"
},
"account": {"href": "https://api.1global.com/connect/acounts/acc_01J6795M195EXEECTPY9Y3QD66"
},
"subscriber": {"href": "https://api.1global.com/connect/subscriber/subr_01J67F1GGCN0ZMGJQ17NTYV3WV"
},
"subscription": {"href": "https://api.1global.com/connect/subscriptions/subs_01J67SMMCM050XM1C1ABQNFD9K"
},
"phone_number": {"href": "https://api.1global.com/connect/phone-numbers/pn_01J6795M195EXEECTPY9Y3QD66"
},
"request-cancelation": {"href": "https://api.1global.com/connect/portings/port_01J67SMMCM050XM1C1ABQNFD9K/request-cancelation"
}
}
}
}
}

Porting Processing Webhook

This webhook is triggered when a porting request is in Processing

Authorizations:

basicAuth

Request Body schema: application/hal+json
required

Porting Processing event schema

One of

id required	string (EventId) <= 100 characters A string that uniquely identifies an Event
type required	string Value: "porting.processing" The type of notification
created_at required	string <date-time> (Iso8601DateTime) The Date Time format according to the ISO 8601
required	object

Responses

Request samples

Payload

Content type

application/hal+json

Example

Porting Port-In Processing Example

{"id": "evt_01J494G6WZAR2E2808Z8M07K4Z",
"type": "porting.processing",
"created_at": "2021-02-01T14:28:17.967Z",
"data": {"porting": {"id": "port_01J6HE2DP5M8GKQ9P8R83VQW3J",
"direction": "in",
"preferred_schedule": {"type": "specific_date",
"preferred_porting_at": "2024-08-30T10:42:34.309Z"
},
"country": "DE",
"status": "processing",
"msisdn": "+4912341234123",
"donor_details": {"_embedded": {"network_operator": {"id": "nopr_01J6795M195EXEECTPY9Y3QD66",
"name": "Operator Name",
"trade_name": "Trade Operator Name",
"country": "DE",
"status": "active",
"created_at": "2024-08-30T10:42:34.309Z",
"updated_at": "2024-08-30T10:42:34.309Z",
"_links": {"self": {"href": "https://api.1global.com/connect/network-operators/nopr_01J6795M195EXEECTPY9Y3QD66"
}
}
},
"service_provider": {"id": "spro_01J6795M195EXEECTPY9Y3QD66",
"name": "Provider Name",
"country": "DE",
"status": "active",
"created_at": "2024-08-30T10:42:34.309Z",
"updated_at": "2024-08-30T10:42:34.309Z",
"_links": {"self": {"href": "https://api.1global.com/connect/service-providers/spro_01J6795M195EXEECTPY9Y3QD66"
}
}
}
},
"account": {"type": "personal"
}
},
"scheduled_at": "2024-10-01T14:28:17.456Z",
"created_at": "2024-08-30T10:42:34.309Z",
"updated_at": "2024-08-30T10:42:34.309Z",
"_links": {"self": {"href": "https://api.1global.com/connect/portings/port_01J6HE2DP5M8GKQ9P8R83VQW3J"
},
"account": {"href": "https://api.1global.com/connect/acounts/acc_01J6795M195EXEECTPY9Y3QD66"
},
"subscriber": {"href": "https://api.1global.com/connect/subscriber/subr_01J67F1GGCN0ZMGJQ17NTYV3WV"
},
"subscription": {"href": "https://api.1global.com/connect/subscriptions/subs_01J67SMMCM050XM1C1ABQNFD9K"
},
"phone_number": {"href": "https://api.1global.com/connect/phone-numbers/pn_01J6795M195EXEECTPY9Y3QD66"
}
}
}
}
}

Porting Completed Webhook

This webhook is triggered when a porting request is in Completed

Authorizations:

basicAuth

Request Body schema: application/hal+json
required

Porting Completed event schema

One of

id required	string (EventId) <= 100 characters A string that uniquely identifies an Event
type required	string Value: "porting.completed" The type of notification
created_at required	string <date-time> (Iso8601DateTime) The Date Time format according to the ISO 8601
required	object

Responses

Request samples

Payload

Content type

application/hal+json

Example

Porting Port-In Completed Example

{"id": "evt_01J494G6WZAR2E2808Z8M07K4Z",
"type": "porting.completed",
"created_at": "2021-02-01T14:28:17.967Z",
"data": {"porting": {"id": "port_01J6HE2DP5M8GKQ9P8R83VQW3J",
"direction": "in",
"preferred_schedule": {"type": "specific_date",
"preferred_porting_at": "2024-08-30T10:42:34.309Z"
},
"country": "DE",
"status": "completed",
"msisdn": "+4912341234123",
"donor_details": {"_embedded": {"network_operator": {"id": "nopr_01J6795M195EXEECTPY9Y3QD66",
"name": "Operator Name",
"trade_name": "Trade Operator Name",
"country": "DE",
"status": "active",
"created_at": "2024-08-30T10:42:34.309Z",
"updated_at": "2024-08-30T10:42:34.309Z",
"_links": {"self": {"href": "https://api.1global.com/connect/network-operators/nopr_01J6795M195EXEECTPY9Y3QD66"
}
}
},
"service_provider": {"id": "spro_01J6795M195EXEECTPY9Y3QD66",
"name": "Provider Name",
"country": "DE",
"status": "active",
"created_at": "2024-08-30T10:42:34.309Z",
"updated_at": "2024-08-30T10:42:34.309Z",
"_links": {"self": {"href": "https://api.1global.com/connect/service-providers/spro_01J6795M195EXEECTPY9Y3QD66"
}
}
}
},
"account": {"type": "personal"
}
},
"completed_at": "2024-10-01T14:28:17.456Z",
"created_at": "2024-08-30T10:42:34.309Z",
"updated_at": "2024-08-30T10:42:34.309Z",
"_links": {"self": {"href": "https://api.1global.com/connect/portings/port_01J6HE2DP5M8GKQ9P8R83VQW3J"
},
"account": {"href": "https://api.1global.com/connect/acounts/acc_01J6795M195EXEECTPY9Y3QD66"
},
"subscriber": {"href": "https://api.1global.com/connect/subscriber/subr_01J67F1GGCN0ZMGJQ17NTYV3WV"
},
"subscription": {"href": "https://api.1global.com/connect/subscriptions/subs_01J67SMMCM050XM1C1ABQNFD9K"
},
"phone_number": {"href": "https://api.1global.com/connect/phone-numbers/pn_01J6795M195EXEECTPY9Y3QD66"
}
}
}
}
}

Porting Cancelation Requested Webhook

This webhook is triggered when a porting request is in CancelationRequested

Authorizations:

basicAuth

Request Body schema: application/hal+json
required

Porting CancelationRequested event schema

One of

id required	string (EventId) <= 100 characters A string that uniquely identifies an Event
type required	string Value: "porting.cancelation_requested" The type of notification
created_at required	string <date-time> (Iso8601DateTime) The Date Time format according to the ISO 8601
required	object

Responses

Request samples

Payload

Content type

application/hal+json

Example

Porting Port-In Cancelation Requested Example

{"id": "evt_01J494G6WZAR2E2808Z8M07K4Z",
"type": "porting.cancelation_requested",
"created_at": "2021-02-01T14:28:17.967Z",
"data": {"porting": {"id": "port_01J6HE2DP5M8GKQ9P8R83VQW3J",
"direction": "in",
"preferred_schedule": {"type": "specific_date",
"preferred_porting_at": "2024-08-30T10:42:34.309Z"
},
"country": "DE",
"status": "cancelation_requested",
"msisdn": "+4912341234123",
"donor_details": {"_embedded": {"network_operator": {"id": "nopr_01J6795M195EXEECTPY9Y3QD66",
"name": "Operator Name",
"trade_name": "Trade Operator Name",
"country": "DE",
"status": "active",
"created_at": "2024-08-30T10:42:34.309Z",
"updated_at": "2024-08-30T10:42:34.309Z",
"_links": {"self": {"href": "https://api.1global.com/connect/network-operators/nopr_01J6795M195EXEECTPY9Y3QD66"
}
}
},
"service_provider": {"id": "spro_01J6795M195EXEECTPY9Y3QD66",
"name": "Provider Name",
"country": "DE",
"status": "active",
"created_at": "2024-08-30T10:42:34.309Z",
"updated_at": "2024-08-30T10:42:34.309Z",
"_links": {"self": {"href": "https://api.1global.com/connect/service-providers/spro_01J6795M195EXEECTPY9Y3QD66"
}
}
}
},
"account": {"type": "personal"
}
},
"cancelation_deadline_at": "2024-10-01T14:28:17.456Z",
"scheduled_at": "2024-10-01T14:28:17.456Z",
"created_at": "2024-08-30T10:42:34.309Z",
"updated_at": "2024-08-30T10:42:34.309Z",
"_links": {"self": {"href": "https://api.1global.com/connect/portings/port_01J6HE2DP5M8GKQ9P8R83VQW3J"
},
"account": {"href": "https://api.1global.com/connect/acounts/acc_01J6795M195EXEECTPY9Y3QD66"
},
"subscriber": {"href": "https://api.1global.com/connect/subscriber/subr_01J67F1GGCN0ZMGJQ17NTYV3WV"
},
"subscription": {"href": "https://api.1global.com/connect/subscriptions/subs_01J67SMMCM050XM1C1ABQNFD9K"
},
"phone_number": {"href": "https://api.1global.com/connect/phone-numbers/pn_01J6795M195EXEECTPY9Y3QD66"
}
}
}
}
}

Porting Canceled Webhook

This webhook is triggered when a porting request is in Canceled

Authorizations:

basicAuth

Request Body schema: application/hal+json
required

Porting Canceled event schema

One of

id required	string (EventId) <= 100 characters A string that uniquely identifies an Event
type required	string Value: "porting.canceled" The type of notification
created_at required	string <date-time> (Iso8601DateTime) The Date Time format according to the ISO 8601
required	object

Responses

Request samples

Payload

Content type

application/hal+json

Example

Porting Port-In Canceled Example

{"id": "evt_01J494G6WZAR2E2808Z8M07K4Z",
"type": "porting.canceled",
"created_at": "2021-02-01T14:28:17.967Z",
"data": {"porting": {"id": "port_01J6HE2DP5M8GKQ9P8R83VQW3J",
"direction": "in",
"preferred_schedule": {"type": "specific_date",
"preferred_porting_at": "2024-08-30T10:42:34.309Z"
},
"country": "DE",
"status": "canceled",
"msisdn": "+4912341234123",
"donor_details": {"_embedded": {"network_operator": {"id": "nopr_01J6795M195EXEECTPY9Y3QD66",
"name": "Operator Name",
"trade_name": "Trade Operator Name",
"country": "DE",
"status": "active",
"created_at": "2024-08-30T10:42:34.309Z",
"updated_at": "2024-08-30T10:42:34.309Z",
"_links": {"self": {"href": "https://api.1global.com/connect/network-operators/nopr_01J6795M195EXEECTPY9Y3QD66"
}
}
},
"service_provider": {"id": "spro_01J6795M195EXEECTPY9Y3QD66",
"name": "Provider Name",
"country": "DE",
"status": "active",
"created_at": "2024-08-30T10:42:34.309Z",
"updated_at": "2024-08-30T10:42:34.309Z",
"_links": {"self": {"href": "https://api.1global.com/connect/service-providers/spro_01J6795M195EXEECTPY9Y3QD66"
}
}
}
},
"account": {"type": "personal"
}
},
"canceled_at": "2024-10-01T14:28:17.456Z",
"created_at": "2024-08-30T10:42:34.309Z",
"updated_at": "2024-08-30T10:42:34.309Z",
"_links": {"self": {"href": "https://api.1global.com/connect/portings/port_01J6HE2DP5M8GKQ9P8R83VQW3J"
},
"account": {"href": "https://api.1global.com/connect/acounts/acc_01J6795M195EXEECTPY9Y3QD66"
},
"subscriber": {"href": "https://api.1global.com/connect/subscriber/subr_01J67F1GGCN0ZMGJQ17NTYV3WV"
},
"subscription": {"href": "https://api.1global.com/connect/subscriptions/subs_01J67SMMCM050XM1C1ABQNFD9K"
},
"phone_number": {"href": "https://api.1global.com/connect/phone-numbers/pn_01J6795M195EXEECTPY9Y3QD66"
}
}
}
}
}

Porting Rejected Webhook

This webhook is triggered when a porting request is in Rejected

Authorizations:

basicAuth

Request Body schema: application/hal+json
required

Porting Rejected event schema

One of

id required	string (EventId) <= 100 characters A string that uniquely identifies an Event
type required	string Value: "porting.rejected" The type of notification
created_at required	string <date-time> (Iso8601DateTime) The Date Time format according to the ISO 8601
required	object

Responses

Request samples

Payload

Content type

application/hal+json

Example

Porting Port-In Rejected Example

{"id": "evt_01J494G6WZAR2E2808Z8M07K4Z",
"type": "porting.rejected",
"created_at": "2021-02-01T14:28:17.967Z",
"data": {"porting": {"id": "port_01J6HE2DP5M8GKQ9P8R83VQW3J",
"direction": "in",
"preferred_schedule": {"type": "specific_date",
"preferred_porting_at": "2024-08-30T10:42:34.309Z"
},
"country": "DE",
"status": "rejected",
"msisdn": "+4912341234123",
"donor_details": {"_embedded": {"network_operator": {"id": "nopr_01J6795M195EXEECTPY9Y3QD66",
"name": "Operator Name",
"trade_name": "Trade Operator Name",
"country": "DE",
"status": "active",
"created_at": "2024-08-30T10:42:34.309Z",
"updated_at": "2024-08-30T10:42:34.309Z",
"_links": {"self": {"href": "https://api.1global.com/connect/network-operators/nopr_01J6795M195EXEECTPY9Y3QD66"
}
}
},
"service_provider": {"id": "spro_01J6795M195EXEECTPY9Y3QD66",
"name": "Provider Name",
"country": "DE",
"status": "active",
"created_at": "2024-08-30T10:42:34.309Z",
"updated_at": "2024-08-30T10:42:34.309Z",
"_links": {"self": {"href": "https://api.1global.com/connect/service-providers/spro_01J6795M195EXEECTPY9Y3QD66"
}
}
}
},
"account": {"type": "personal"
}
},
"rejection": {"reason": "wrong_birth_date",
"message": "Wrong birth date",
"rejected_at": "2024-08-31T10:42:34.309Z"
},
"created_at": "2024-08-30T10:42:34.309Z",
"updated_at": "2024-08-30T10:42:34.309Z",
"_links": {"self": {"href": "https://api.1global.com/connect/portings/port_01J6HE2DP5M8GKQ9P8R83VQW3J"
},
"account": {"href": "https://api.1global.com/connect/acounts/acc_01J6795M195EXEECTPY9Y3QD66"
},
"subscriber": {"href": "https://api.1global.com/connect/subscriber/subr_01J67F1GGCN0ZMGJQ17NTYV3WV"
},
"subscription": {"href": "https://api.1global.com/connect/subscriptions/subs_01J67SMMCM050XM1C1ABQNFD9K"
},
"phone_number": {"href": "https://api.1global.com/connect/phone-numbers/pn_01J6795M195EXEECTPY9Y3QD66"
}
}
}
}
}

Contract Created Webhook

This webhook is triggered when a new contract is created.

Authorizations:

basicAuth

Request Body schema: application/hal+json
required

Contract event schema

id required	string (EventId) <= 100 characters A string that uniquely identifies an Event
type required	string Value: "contract.created" The type of notification
created_at required	string <date-time> (Iso8601DateTime) The Date Time format according to the ISO 8601
required	object

Responses

Request samples

Payload

Content type

application/hal+json

{"id": "evt_01J494G6WZAR2E2808Z8M07K4Z",
"type": "contract.created",
"created_at": "2021-02-01T14:28:17.967Z",
"data": {"contract": {"id": "con_1234",
"type": "contract_summary",
"created_at": "2024-08-30T10:42:34.309Z",
"_embedded": {"account": {"id": "acc_01HRC2T6WK4CMVGFXA2RESTQ97",
"_links": {"self": {"href": "https://api.1global.com/connect/accounts/acc_01HRC2T6WK4CMVGFXA2RESTQ97"
}
}
},
"order": {"id": "ord_01HRC2T6WK4CMVGFXA2RESTQ97",
"_links": {"self": {"href": "https://api.1global.com/connect/orders/ord_01HRC2T6WK4CMVGFXA2RESTQ97"
}
}
}
},
"_links": {"self": {"href": "https://api.1global.com/connect/contracts/con_1234"
},
"download": {"href": "https://api.1global.com/a-resource/con_01HRC2T6WK4CMVGFXA2RESTQ97"
}
}
}
}
}

Invoice Open Webhook

This webhook is triggered when a new invoice is open.

Authorizations:

basicAuth

Request Body schema: application/hal+json
required

Invoice event schema

id required	string (EventId) <= 100 characters A string that uniquely identifies an Event
type required	string Value: "invoice.open" The type of notification
created_at required	string <date-time> (Iso8601DateTime) The Date Time format according to the ISO 8601
required	object

Responses

Request samples

Payload

Content type

application/hal+json

{"id": "evt_01J494G6WZAR2E2808Z8M07K4Z",
"type": "invoice.open",
"created_at": "2021-02-01T14:28:17.967Z",
"data": {"invoice": {"id": "inv_1234",
"status": "paid",
"created_at": "2024-10-01T14:28:17.456Z",
"number": "INV-2025-001",
"period": "2025-02-10T00:00:00Z/2025-02-15T23:59:59Z",
"total": {"amount": 5400,
"currency": "EUR"
},
"amount_breakdown": [{"type": "recurring",
"total": {"amount": 2400,
"currency": "EUR"
}
},
{"type": "sms_oob",
"total": {"amount": 600,
"currency": "EUR"
}
},
{"type": "voice_oob",
"total": {"amount": 1200,
"currency": "EUR"
}
},
{"type": "one_off",
"total": {"amount": 1200,
"currency": "EUR"
}
}
],
"_embedded": {"account": {"id": "acc_01BX5ZZKBKACTAV9WEVGEMMVRY",
"_links": {"self": {"href": "https://api.1global.com/connect/accounts/acc_01BX5ZZKBKACTAV9WEVGEMMVRY"
}
}
}
},
"_links": {"self": {"href": "https://api.1global.com/connect/invoices/inv_1234"
},
"download": {"href": "http://api.1global.com/a-resource/inv_01HRC2T6WK4CMVGFXA2RESTQ97"
}
}
}
}
}

1GLOBAL Connect API (2025-01-28)

Accounts

Creates a new Account

Authorizations:

header Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

List all accounts

Authorizations:

query Parameters

header Parameters

Responses

Response samples

Retrieve an account

Authorizations:

path Parameters

header Parameters

Responses

Response samples

Patch an account

Authorizations:

path Parameters

header Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Contracts

List all Contracts

Authorizations:

query Parameters

header Parameters

Responses

Response samples

Retrieve a contract

Authorizations:

path Parameters

header Parameters

Responses

Response samples

Coverage Areas

List all Coverage Areas

Authorizations:

query Parameters

header Parameters

Responses

Response samples

Retrieve a Coverage Area

Authorizations:

path Parameters

header Parameters

Responses

Response samples

Invoices

List all Invoices

Authorizations:

query Parameters

header Parameters

Responses

Response samples

Retrieve a invoice

Authorizations:

path Parameters

header Parameters

Responses

Response samples

List all Invoices Items

Authorizations:

path Parameters

query Parameters

header Parameters

Responses

Response samples

Network Operators

List all network-operators

Authorizations:

query Parameters

header Parameters

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required