1GLOBAL Enterprise APIs (1.0)

Download OpenAPI specification:Download

1GLOBAL Enterprise APIs

Subscriptions

Endpoints for managing your subscriptions

List Subscriptions

Authorizations:

JWT

query Parameters

status	string Enum: "active" "terminated" The status of the subscription
limit	integer <int32> (Limit) [ 1 .. 100 ] Default: 10
cursor	string (Cursor) [ 1 .. 128 ] characters

header Parameters

Prefer

string

Example: transclude="subscriber;account;sim_profile;phone_numbers;services"

What embedded resources to include in the response

Responses

Response samples

200
401

Content type

application/json

{"_embedded": {"subscriptions": [{"id": "sub_01HTQ8ZW1JVSFRWJX51K4CTX7Y",
"status": "active",
"created_at": "2023-01-01T00:00:00:000Z",
"terminated_at": null,
"_embedded": {"account": {"id": "acc_01HTQ8VBN4DEJP5S8BPV4657VG",
"reference_code": "123456789",
"name": "string",
"country": "string"
},
"subscriber": {"id": "sbr_01HTQ8Z5HR26EN2HE797W5SZP9",
"first_name": "string",
"last_name": "string",
"email": "string",
"employee_id": "string",
"group": "string"
},
"sim_profile": {"iccid": "string",
"sim_type": "esim",
"_links": {"self": {"href": "https://api.1global.com/enterprise/subscriptions/sub_01HTJA47C93ABKKR58T05JBAJB/sim-profile"
}
}
},
"phone_numbers": {"_links": {"self": {"href": "https://api.1global.com/enterprise/subscriptions/sub_01HTJA47C93ABKKR58T05JBAJB/phone-numbers"
}
},
"_embedded": {"phone_numbers": [{"msisdn": "string",
"is_primary": true,
"country": "string"
}
]
}
},
"services": {"_links": {"self": {"href": "https://api.1global.com/enterprise/subscriptions/sub_01HTJA47C93ABKKR58T05JBAJB/services"
}
},
"_embedded": {"services": [{"type": "voice",
"enabled": true
}
]
}
}
}
}
]
}
}

Get Subscription

Authorizations:

JWT

path Parameters

id	string Example: sub_01HTJA47C93ABKKR58T05JBAJB The ID of the subscription

header Parameters

Prefer

string

Example: transclude="subscriber;account;sim_profile;phone_numbers;services"

What embedded resources to include in the response

Responses

Response samples

200
401
404

Content type

application/json

{"id": "sub_01HTQ8ZW1JVSFRWJX51K4CTX7Y",
"status": "active",
"created_at": "2023-01-01T00:00:00:000Z",
"terminated_at": null,
"_embedded": {"account": {"id": "acc_01HTQ8VBN4DEJP5S8BPV4657VG",
"reference_code": "123456789",
"name": "string",
"country": "string"
},
"subscriber": {"id": "sbr_01HTQ8Z5HR26EN2HE797W5SZP9",
"first_name": "string",
"last_name": "string",
"email": "string",
"employee_id": "string",
"group": "string"
},
"sim_profile": {"iccid": "string",
"sim_type": "esim",
"_links": {"self": {"href": "https://api.1global.com/enterprise/subscriptions/sub_01HTJA47C93ABKKR58T05JBAJB/sim-profile"
}
}
},
"phone_numbers": {"_links": {"self": {"href": "https://api.1global.com/enterprise/subscriptions/sub_01HTJA47C93ABKKR58T05JBAJB/phone-numbers"
}
},
"_embedded": {"phone_numbers": [{"msisdn": "string",
"is_primary": true,
"country": "string"
}
]
}
},
"services": {"_links": {"self": {"href": "https://api.1global.com/enterprise/subscriptions/sub_01HTJA47C93ABKKR58T05JBAJB/services"
}
},
"_embedded": {"services": [{"type": "voice",
"enabled": true
}
]
}
}
}
}

Get Subscription's Phone Numbers

Authorizations:

JWT

path Parameters

id	string Example: sub_01HTJA47C93ABKKR58T05JBAJB The ID of the subscription

Responses

Response samples

200
401
404

Content type

application/hal+json

{"_links": {"self": {"href": "https://api.1global.com/enterprise/subscriptions/sub_01HTJA47C93ABKKR58T05JBAJB/phone-numbers"
}
},
"_embedded": {"phone_numbers": [{"msisdn": "string",
"is_primary": true,
"country": "string"
}
]
}
}

Get Subscription's Services

Authorizations:

JWT

path Parameters

id	string Example: sub_01HTJA47C93ABKKR58T05JBAJB The ID of the subscription

Responses

Response samples

200
401
404

Content type

application/hal+json

{"_links": {"self": {"href": "https://api.1global.com/enterprise/subscriptions/sub_01HTJA47C93ABKKR58T05JBAJB/services"
}
},
"_embedded": {"services": [{"type": "voice",
"enabled": true
}
]
}
}

Get Subscription's Sim Profile

Authorizations:

JWT

path Parameters

id	string Example: sub_01HTJA47C93ABKKR58T05JBAJB The ID of the subscription

Responses

Response samples

200
401
404

Content type

application/hal+json

{"iccid": "string",
"sim_type": "esim",
"_links": {"self": {"href": "https://api.1global.com/enterprise/subscriptions/sub_01HTJA47C93ABKKR58T05JBAJB/sim-profile"
}
}
}