Get Objects

APIs related to retrieving Limio Objects

Get Object

get

These APIs allow you to retrieve specific objects in Limio. You can get a subscription, customer, order, identity, address, schedule, payment method, subscription offer, user entitlement, event or process event object. You can also get a list of objects of a specific type using the Get Objects API.

Authorizations
AuthorizationstringRequired

To create a Bearer token, see How to get an OAuth Bearer Token?.

Usage format: Bearer <token>

Path parameters
servicestring · enumRequired

The service the object belongs to

Default: limioPossible values:
path_typestring · enumRequiredPossible values:
idstringRequiredExample: sub-abcxyz123456
Responses
get
/objects/{service}/{path_type}/{id}

Get Objects

get

These APIs allow you to retrieve a list of objects of a specific type in Limio. You can get a subscription, customer, order, identity, address, schedule, payment method, subscription offer, user entitlement, event or process event objects. Each object is returned with a summary of its data. To fetch all of the object data, use the retrieved object ID with the Get Object API.

Authorizations
AuthorizationstringRequired

To create a Bearer token, see How to get an OAuth Bearer Token?.

Usage format: Bearer <token>

Path parameters
servicestring · enumRequired

The service the object belongs to

Default: limioPossible values:
path_typestring · enumRequiredPossible values:
Query parameters
limitnumberOptional

The number of objects to return.

Example: 10
queryMorestringOptional

Retrieves the next page of results. Use the queryMore returned in the previous response.

Example: DnF1ZXJ5VGhlbkZldGNoBQAAAAAAGH
Responses
get
/objects/{service}/{path_type}
get

This API allows you to get objects related to a specific object in Limio. You can get related objects of a subscription, customer, order, identity, address, schedule, payment method, subscription offer, or user entitlement.

chevron-right
lockRequired scopes
This endpoint requires the following scopes:
Authorizations
AuthorizationstringRequired

To create a Bearer token, see How to get an OAuth Bearer Token?.

Usage format: Bearer <token>

Path parameters
servicestring · enumRequired

The service the object belongs to

Default: limioPossible values:
path_typestring · enumRequiredPossible values:
idstringRequiredExample: sub-abcxyz123456
Responses
get
/objects/{service}/{path_type}/{id}/related
get

This API allows you to get objects related to a specific object of provided path type from a provided service using the object's ID. You can get related objects of a subscription, customer, order, identity, address, schedule, payment method, subscription offer, or user entitlement.

chevron-right
lockRequired scopes
This endpoint requires the following scopes:
Authorizations
AuthorizationstringRequired

To create a Bearer token, see How to get an OAuth Bearer Token?.

Usage format: Bearer <token>

Path parameters
servicestring · enumRequired

The service the object belongs to

Default: limioPossible values:
idstringRequiredExample: sub-abcxyz123456
path_typestring · enumRequiredPossible values:
record_typestring · enumRequired

The record type of the object

Possible values:
Responses
get
/objects/{service}/{path_type}/{id}/related/{record_type}

Get Object Subtype

get

This API allows you to retrieve all children objects of a parent object using the object's ID. You can get a subscription, customer, order, identity, address, schedule, payment method, subscription offer, or user entitlement. Each object is returned with a summary of its data. To fetch all of the object data, use the retrieved object ID with the Get Object API.

chevron-right
lockRequired scopes
This endpoint requires the following scopes:
Authorizations
AuthorizationstringRequired

To create a Bearer token, see How to get an OAuth Bearer Token?.

Usage format: Bearer <token>

Path parameters
servicestring · enumRequired

The service the object belongs to

Default: limioPossible values:
path_typestring · enumRequiredPossible values:
idstringRequiredExample: sub-abcxyz123456
Responses
get
/objects/{service}/{path_type}/{id}/objects

Get Object Subtype By Record Type

get

This API allows you to retrieve specific children objects, that match the provided record_type, of a parent object using the object's ID. You can get a subscription, customer, order, identity, address, schedule, payment method, subscription offer, or user entitlement. Each object is returned with a summary of its data. To fetch all of the object data, use the retrieved object ID with the Get Object API.

chevron-right
lockRequired scopes
This endpoint requires the following scopes:
Authorizations
AuthorizationstringRequired

To create a Bearer token, see How to get an OAuth Bearer Token?.

Usage format: Bearer <token>

Path parameters
servicestring · enumRequired

The service the object belongs to

Default: limioPossible values:
path_typestring · enumRequiredPossible values:
idstringRequiredExample: sub-abcxyz123456
subtypestring · enumOptional

The subtype of an object

Possible values:
Responses
get
/objects/{service}/{path_type}/{id}/objects/{subtype}

Get Object Events

get

This API allows you to get events associated with a specific object of provided path type from a provided service using the object's ID. You can get events of a subscription, customer, order, identity, address, schedule, payment method, subscription offer, or user entitlement. Events are actions that have been performed and are related to the object. Commonly this will be used to see events related to a subscription, such as creating or updating a susbcription.

chevron-right
lockRequired scopes
This endpoint requires the following scopes:
Authorizations
AuthorizationstringRequired

To create a Bearer token, see How to get an OAuth Bearer Token?.

Usage format: Bearer <token>

Path parameters
servicestring · enumRequired

The service the object belongs to

Default: limioPossible values:
path_typestring · enumRequiredPossible values:
idstringRequiredExample: sub-abcxyz123456
Responses
get
/objects/{service}/{path_type}/{id}/events

Last updated

Was this helpful?