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
Path parameters
servicestring · enumRequired
The service the object belongs to
Default: limioPossible values:
path_typestring · enumRequiredPossible values:
idstringRequiredExample: sub-abcxyz123456
Responses
200
OK
application/json
Responseone of
or
or
or
or
or
or
or
or
401
Unauthorized
application/json
502
Bad Gateway
application/json
get
GET /api/objects/{service}/{path_type}/{id} HTTP/1.1
Host: your-environment.prod.limio.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
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
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
200
OK
application/json
401
Unauthorized
application/json
502
Bad Gateway
application/json
get
GET /api/objects/{service}/{path_type} HTTP/1.1
Host: your-environment.prod.limio.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
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.
Authorizations
Path parameters
servicestring · enumRequired
The service the object belongs to
Default: limioPossible values:
path_typestring · enumRequiredPossible values:
idstringRequiredExample: sub-abcxyz123456
Responses
200
OK
application/json
401
Unauthorized
application/json
502
Bad Gateway
application/json
get
GET /api/objects/{service}/{path_type}/{id}/related HTTP/1.1
Host: your-environment.prod.limio.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
This API allows you to update objects in Limio. You can update a subscription, customer, order, identity, address, schedule, payment method, subscription offer, promo code, or user entitlement. It is designed to be flexible and allow you to update any field in the object.
Authorizations
Path parameters
servicestring · enumRequired
The service the object belongs to
Default: limioPossible values:
path_typestring · enumRequiredPossible values:
idstringRequiredExample: sub-abcxyz123456
Body
namestringOptional
The object name such as the subscription name, or gift code name. Not included values will not be updated and nested values will require the structure to update. Updates will only occur for the id provided. WARNING! Changing this field might break integrations