Subscription API

Full documentation on how to use our Subscription REST API can be found here: Subscription REST API

Get Object Relationships

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.

GEThttps://your-environment.prod.limio.com/api/objects/{service}/{path_type}/{id}/related

Authorization

bearerAuth

Path parameters

service*enum

The service the object belongs to

limiozuorasalesforce

path_type*enum

orderscustomerssubscriptionsidentitiesaddressschedulespayment_methodssubscription_offersuser_entitlements

id*string

Example: "sub-abcxyz123456"

Response

200401502

OK

Body

application/json

itemsarray of object

Request

JavaScriptCurlPython

const response = await fetch('https://your-environment.prod.limio.com/api/objects/{service}/{path_type}/{id}/related', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer <token>"
    },
});
const data = await response.json();

Response

200401502

{
  "items": [
    {
      "name": "Limio Subscription",
      "id": "e3535c52-3058-472e-aa4f-fe772a7c0f38",
      "relationship_id": "rel-123123sasdas",
      "type": "zuora",
      "record_type": "subscription",
      "service": "limio",
      "mode": "production",
      "created": "2020-03-18T16:02:01.526Z",
      "data": {
        "reference": "217OU0391HEG",
        "id": "e3535c52-3058-472e-aa4f-fe772a7c0f38",
        "related": "order-bcc1997b17b7824caf86b06451904fb8",
        "record_type": "rel",
        "service": "limio",
        "mode": "production",
        "created": "2020-03-18T16:02:01.526Z",
        "data": {
          "from": {
            "name": "Limio Subscription",
            "id": "e3535c52-3058-472e-aa4f-fe772a7c0f38",
            "record_type": "subscription",
            "service": "limio"
          },
          "to": {
            "name": "Limio Order",
            "id": "order-bcc1997b17b7824caf86b06451904fb8",
            "record_type": "order",
            "service": "limio"
          }
        }
      }
    }
  ]
}