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.

get

/objects/{service}//{path_type}//{id}/related

Authorizations

Path parameters

servicestring · enum · default: limiorequired

The service the object belongs to

Options: limio, zuora, salesforce

path_typestring · enumrequired

Options: orders, customers, subscriptions, identities, address, schedules, payment_methods, subscription_offers, user_entitlements

idstringrequired

Example: sub-abcxyz123456

Responses

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://your-environment.prod.limio.com/api/objects/{service}/{path_type}/{id}/related' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

401

502

200

{
  "items": [
    {
      "name": "Limio Subscription",
      "id": "e3535c52-3058-472e-aa4f-fe772a7c0f38",
      "relationship_id": "rel-123123sasdas",
      "mode": "production",
      "created": "2020-03-18T16:02:01.526Z",
      "type": "zuora",
      "record_type": "subscription",
      "service": "limio",
      "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": {
          "metadata": {},
          "from": {
            "name": "Limio Subscription",
            "id": "e3535c52-3058-472e-aa4f-fe772a7c0f38",
            "record_type": "subscription",
            "service": "limio",
            "data": {}
          },
          "to": {
            "name": "Limio Order",
            "id": "order-bcc1997b17b7824caf86b06451904fb8",
            "record_type": "order",
            "service": "limio",
            "data": {}
          }
        }
      }
    }
  ]
}

OK