Objects

Retrieve, update, and delete Limio objects by type — subscriptions, customers, orders, identities, addresses, schedules, payment methods, subscription offers, entitlements, events, and process events. Supports pagination and relationship traversal.

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, process event or checkout basket object. You can also get a list of objects of a specific type using the Get Objects API. To retrieve a checkout basket, use path type baskets with the basket ID (e.g. basket-22e3d318-92e2-4909-b59c-1265623bc3f6). Baskets are read-only via this API; to modify a basket, use the Update Checkout Basket API instead.

Authorizations

AuthorizationstringRequired

OAuth 2.0 Bearer token for authenticated API access. Required for order submission, object management, and administrative operations.

Obtain a token via the OAuth flow described in OAuth Bearer Token.

Pass the token in the Authorization header: Bearer <token>

Path parameters

servicestring · enumRequired

The service the object belongs to

Default: limioPossible values:

path_typestring · enumRequired

The type of object to operate on. Determines the shape of the response data and which fields are available.

Example: subscriptionsPossible values:

idstringRequired

The unique identifier of the object. Format varies by object type (e.g. sub-... for subscriptions, cus-... for customers, order-... for orders, basket-... for baskets).

Example: sub-abcxyz123456

Responses

200

application/json

401

Unauthorized: the request lacks valid authentication credentials. This response is returned by the API gateway before the request reaches the application. Verify your Bearer token is correct and has not expired.

application/json

502

Bad Gateway — an upstream service returned an unexpected response. This typically indicates an issue with the request payload (e.g. invalid field values, missing required fields) or a transient infrastructure error. Retry the request, and if the issue persists, verify the request body matches the expected schema.

application/json

get/objects/{service}/{path_type}/{id}

GET /api/objects/{service}/{path_type}/{id} HTTP/1.1
Host: your-environment.prod.limio.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "name": "3V053CN9SFIG",
  "start": "2024-03-22",
  "data": {
    "name": "$75 for 52 weeks then $31.96 every 4 weeks autorenew",
    "tracking": {
      "offers": [
        "/offers2/$75 for 52 weeks then $31.96 every 4 weeks autorenew"
      ],
      "purchaseCountryCode": "GB",
      "accountId": "0017x00000Q9O9qAAF",
      "zuoraAccountNumber": "A00001234",
      "contactId": "0037x00000F58M9AAJ",
      "userId": "0057x0000088Oh3AAE"
    },
    "offer": {
      "mode": "production",
      "path": "/offers2/$75 for 52 weeks then $31.96 every 4 weeks autorenew",
      "data": {
        "price__limio": [],
        "created": "2024-02-28T15:22:14+00:00",
        "duplicatedFrom": "/offers2/$75 for 52 weeks then $31.96 every 4 weeks autorenew",
        "type": "item",
        "version": "64e79ce3cbe2474c5b5fcbc5af229ec0d2439b12",
        "record_type": "offer",
        "productBundles": [
          {
            "revenue_split": "100",
            "product_path": "/products/Digital",
            "rate_plan": "$75 dollar per week"
          }
        ],
        "products": [
          {
            "baseTemplate": "/config/templates/products/default",
            "entitlements": [
              {
                "$ref": "/entitlements/Digital"
              }
            ],
            "path": "/products/Digital",
            "created": "2023-12-11T13:44:43+00:00",
            "modified": "2024-01-15T13:56:18+00:00",
            "attributes": {
              "display_name__limio": "Digital",
              "has_delivery__limio": false,
              "product_code__limio": "LI.DIGITAL"
            },
            "record_type": "product",
            "lastSynced": "2024-03-12T16:00:35.232Z",
            "synced": true,
            "syncedFrom": "2c92c0f9778c090d0177aa4f357d043b"
          }
        ],
        "baseTemplate": "/config/templates/offers/default",
        "path": "/offers2/$75 for 52 weeks then $31.96 every 4 weeks autorenew",
        "priceReference": "/offers2/$75 for 52 weeks then $31.96 every 4 weeks autorenew",
        "price": [],
        "name": "$75 for 52 weeks then $31.96 every 4 weeks autorenew",
        "modified": "2024-03-08T10:53:37+00:00",
        "attributes": {
          "checkout_description__limio": "<p>Description</p>",
          "price__limio": [
            {
              "delay_interval_type": "weeks",
              "name": "charge_1",
              "delay_interval": "2",
              "repeat_interval": 52,
              "attributes": [],
              "label": "Charge 1",
              "trigger": "order_date",
              "repeat_interval_type": "weeks",
              "repeat_count": 1,
              "type": "recurring",
              "value": "75.00",
              "currencyCode": "USD"
            }
          ],
          "default_quantity_options__limio": null,
          "supportBillingFrequencyChange__zuora": true,
          "allowed_countries__limio": [
            "AX"
          ],
          "label__limio": [
            "default"
          ],
          "term__limio": {
            "renewal_type": "EVERGREEN",
            "renewal_trigger": "EXTERNAL"
          },
          "display_price__limio": "<p>Display Price</p>",
          "cta_text__limio": "buy",
          "payment_types__limio": [
            "zuora_card"
          ],
          "sales_channel__limio": [
            "Online"
          ],
          "display_name__limio": "$75 for 52 weeks then $31.96 every 4 weeks autorenew 1",
          "checkout__limio": {
            "checkout_type": "standard"
          },
          "initial_term__limio": {
            "renewal_type": "TERMED",
            "length": 52,
            "renewal_trigger": "EXTERNAL",
            "type": "weeks"
          },
          "push_to_checkout__limio": true,
          "autoRenew__limio": true,
          "offer_type__limio": "standard"
        },
        "id": "998f6ca141d60006e1e239b9f4b4e725bf1615d3",
        "user": "user@domain.com"
      },
      "service": "limio",
      "created": "2024-03-12T17:30:40.337Z",
      "name": "$75 for 52 weeks then $31.96 every 4 weeks autorenew",
      "id": "998f6ca141d60006e1e239b9f4b4e725bf1615d3",
      "type": "item",
      "updated": "2024-03-12T17:30:40.337Z",
      "version": "121defc69da9962e4b78424234577aa7717f4daf",
      "record_type": "offer",
      "status": "active"
    },
    "quantity": 1,
    "termEndDate": "2025-03-21",
    "price": {
      "summary": {
        "headline": "<p>Display Price</p>"
      },
      "currency": "USD",
      "amount": 75
    },
    "termStartDate": "2024-03-22",
    "attributes": {
      "gift": false,
      "external": false
    },
    "id": "bdc3cfb7-77b9-d8b8-7395-f44758ef1b29",
    "purchaseCountry": "GB",
    "startDate": "2024-03-22",
    "products": [
      {
        "baseTemplate": "/config/templates/products/default",
        "entitlements": [
          {
            "$ref": "/entitlements/Digital"
          }
        ],
        "path": "/products/Digital",
        "created": "2023-12-11T13:44:43+00:00",
        "modified": "2024-01-15T13:56:18+00:00",
        "attributes": {
          "display_name__limio": "Digital",
          "has_delivery__limio": false,
          "product_code__limio": "LI.DIGITAL"
        },
        "record_type": "product",
        "lastSynced": "2024-03-12T16:00:35.232Z",
        "synced": true,
        "syncedFrom": "2c92c0f9778c090d0177aa4f357d043b"
      }
    ]
  },
  "status": "initial",
  "record_type": "subscription",
  "owner": "id-39e4c3727b273ec4110b5769c10cdb52",
  "customer": "cus-81f7a36b4737e4d07b56e89d392a4d6e",
  "id": "sub-7f0146cba78f9455e57875402643f103",
  "service": "limio",
  "ref": "order-db546637c354a63b0eeaa121a0c14f0b/bdc3cfb7-77b9-d8b8-7395-f44758ef1b29",
  "created": "2024-03-22T12:13:29.718Z",
  "updated": "2024-03-22T12:13:29.718Z",
  "reference": "3V053CN9SFIG",
  "mode": "production"
}

Update Object

put

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

AuthorizationstringRequired

OAuth 2.0 Bearer token for authenticated API access. Required for order submission, object management, and administrative operations.

Obtain a token via the OAuth flow described in OAuth Bearer Token.

Pass the token in the Authorization header: Bearer <token>

Path parameters

servicestring · enumRequired

The service the object belongs to

Default: limioPossible values:

path_typestring · enumRequired

The type of object to operate on. Determines the shape of the response data and which fields are available.

Example: subscriptionsPossible values:

idstringRequired

The unique identifier of the object. Format varies by object type (e.g. sub-... for subscriptions, cus-... for customers, order-... for orders, basket-... for baskets).

Example: 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

Example: abc123

dataone ofRequired

Responses

200

application/json

idstringOptional

The ID of the object

Example: sub-123123123

sort_keystringOptional

The sort key of the object

Example: object/subscription

dataobjectOptional

The data of the object sent in the request

Example: {"quantity":2}

400

Bad request (missing required fields)

401

application/json

404

Not found

put/objects/{service}/{path_type}/{id}

PUT /api/objects/{service}/{path_type}/{id} HTTP/1.1
Host: your-environment.prod.limio.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 39

{
  "name": "abc123",
  "data": {
    "quantity": 2
  }
}

{
  "id": "sub-123123123",
  "sort_key": "object/subscription",
  "data": {
    "quantity": 2
  }
}

Delete Object

delete

This API allows you to delete objects in Limio. Currently, promo codes (v2 and v3) and saved searches can be deleted via this API.

Authorizations

AuthorizationstringRequired

OAuth 2.0 Bearer token for authenticated API access. Required for order submission, object management, and administrative operations.

Obtain a token via the OAuth flow described in OAuth Bearer Token.

Pass the token in the Authorization header: Bearer <token>

Path parameters

servicestring · enumRequired

The service the object belongs to

Default: limioPossible values:

path_typestring · enumRequired

The type of object to operate on. Determines the shape of the response data and which fields are available.

Example: subscriptionsPossible values:

idstringRequired

The unique identifier of the object. Format varies by object type (e.g. sub-... for subscriptions, cus-... for customers, order-... for orders, basket-... for baskets).

Example: sub-abcxyz123456

Responses

200

application/json

401

application/json

404

Not found

502

application/json

delete/objects/{service}/{path_type}/{id}

DELETE /api/objects/{service}/{path_type}/{id} HTTP/1.1
Host: your-environment.prod.limio.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "$metadata": {
    "httpStatusCode": 200,
    "requestId": "1234ABC",
    "attempts": 1,
    "totalRetryDelay": 0
  }
}

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

OAuth 2.0 Bearer token for authenticated API access. Required for order submission, object management, and administrative operations.

Obtain a token via the OAuth flow described in OAuth Bearer Token.

Pass the token in the Authorization header: Bearer <token>

Path parameters

servicestring · enumRequired

The service the object belongs to

Default: limioPossible values:

path_typestring · enumRequired

The type of object to operate on. Determines the shape of the response data and which fields are available.

Example: subscriptionsPossible values:

Query parameters

limitintegerOptional

Maximum number of objects to return. Defaults to 50 if not specified.

Default: 50Example: 10

queryMorestringOptional

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

Example: DnF1ZXJ5VGhlbkZldGNoBQAAAAAAGH

Responses

200

application/json

401

application/json

502

application/json

get/objects/{service}/{path_type}

GET /api/objects/{service}/{path_type} HTTP/1.1
Host: your-environment.prod.limio.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "queryMore": "eyJjcmVhdGVkIjoiMjAyNC0wMy0wMVQwMTozNjowOC43MjVaIiwic29ydF9rZXkiOiJvYmplY3Qvc3Vic2NyaXB0aW9uIiwiaGFzaCI6ImVjb25vbWlzdC1iYXUtcHJlcHJvZC9wcm9kdWN0aW9uL2xpbWlvL3N1Yi02YjExOTliOTkzYTQyNDdmZDgwNTRlMWFkNzZiOGVjOSIsInJlY29yZF90eXBlIjoiZWNvbm9taXN0LWJhdS1wcmVwcm9kL3Byb2R1Y3Rpb24vbGltaW8vc3Vic2NyaXB0aW9uIn0=",
  "items": [
    {
      "name": "2JTPIUPFQCQ0",
      "data": {
        "email": "user@domain.com",
        "name": "First Last",
        "tracking": {
          "offers": [
            "/offers2/$75 for 52 weeks then $31.96 every 4 weeks autorenew"
          ],
          "purchaseCountryCode": "GB",
          "accountId": "0017x00000Q9O9qAAF",
          "zuoraAccountNumber": "A00001234",
          "contactId": "0037x00000F58M9AAJ",
          "userId": "0057x0000088Oh3AAE"
        },
        "country": "GB",
        "billingDetails": {
          "country": "GB",
          "firstName": "First",
          "lastName": "Last",
          "streetName": "Street",
          "city": "City",
          "address1": "Address 1",
          "address2": "Address 2",
          "postalCode": "SW1A 1AA",
          "buildingNumber": 1,
          "company": "Company",
          "state": "State"
        },
        "__spec_version": "2",
        "external_id": "1HPJ18UUJRV",
        "source": "salesforce",
        "orderItems": [
          {
            "offer": {
              "mode": "production",
              "path": "/offers2/Digital Monthly UK multiple",
              "data": {
                "price__limio": [],
                "created": "2024-02-28T15:22:14+00:00",
                "duplicatedFrom": "/offers2/$75 for 52 weeks then $31.96 every 4 weeks autorenew",
                "type": "item",
                "version": "64e79ce3cbe2474c5b5fcbc5af229ec0d2439b12",
                "record_type": "offer",
                "productBundles": [
                  {
                    "revenue_split": "100",
                    "product_path": "/products/Digital",
                    "rate_plan": "$75 dollar per week"
                  }
                ],
                "products": [
                  {
                    "baseTemplate": "/config/templates/products/default",
                    "entitlements": [
                      {
                        "$ref": "/entitlements/Digital"
                      }
                    ],
                    "path": "/products/Digital",
                    "created": "2023-12-11T13:44:43+00:00",
                    "modified": "2024-01-15T13:56:18+00:00",
                    "attributes": {
                      "display_name__limio": "Digital",
                      "has_delivery__limio": false,
                      "product_code__limio": "LI.DIGITAL"
                    },
                    "record_type": "product",
                    "lastSynced": "2024-03-12T16:00:35.232Z",
                    "synced": true,
                    "syncedFrom": "2c92c0f9778c090d0177aa4f357d043b"
                  }
                ],
                "baseTemplate": "/config/templates/offers/default",
                "path": "/offers2/$75 for 52 weeks then $31.96 every 4 weeks autorenew",
                "priceReference": "/offers2/$75 for 52 weeks then $31.96 every 4 weeks autorenew",
                "price": [],
                "name": "$75 for 52 weeks then $31.96 every 4 weeks autorenew",
                "modified": "2024-03-08T10:53:37+00:00",
                "attributes": {
                  "checkout_description__limio": "<p>Description</p>",
                  "price__limio": [
                    {
                      "delay_interval_type": "weeks",
                      "name": "charge_1",
                      "delay_interval": "2",
                      "repeat_interval": 52,
                      "attributes": [],
                      "label": "Charge 1",
                      "trigger": "order_date",
                      "repeat_interval_type": "weeks",
                      "repeat_count": 1,
                      "type": "recurring",
                      "value": "75.00",
                      "currencyCode": "USD"
                    }
                  ],
                  "default_quantity_options__limio": null,
                  "supportBillingFrequencyChange__zuora": true,
                  "allowed_countries__limio": [
                    "AX"
                  ],
                  "label__limio": [
                    "default"
                  ],
                  "term__limio": {
                    "renewal_type": "EVERGREEN",
                    "renewal_trigger": "EXTERNAL"
                  },
                  "display_price__limio": "<p>Display Price</p>",
                  "cta_text__limio": "buy",
                  "payment_types__limio": [
                    "zuora_card"
                  ],
                  "sales_channel__limio": [
                    "Online"
                  ],
                  "display_name__limio": "$75 for 52 weeks then $31.96 every 4 weeks autorenew 1",
                  "checkout__limio": {
                    "checkout_type": "standard"
                  },
                  "initial_term__limio": {
                    "renewal_type": "TERMED",
                    "length": 52,
                    "renewal_trigger": "EXTERNAL",
                    "type": "weeks"
                  },
                  "push_to_checkout__limio": true,
                  "autoRenew__limio": true,
                  "offer_type__limio": "standard"
                },
                "id": "998f6ca141d60006e1e239b9f4b4e725bf1615d3",
                "user": "user@domain.com"
              },
              "service": "limio",
              "created": "2024-01-24T10:18:17.578Z",
              "name": "Digital Monthly UK multiple",
              "id": "95dc800a5c77fd461744c9e0c638ac58c778eeaf",
              "type": "item",
              "updated": "2024-01-24T10:18:17.578Z",
              "version": "8f72261aebfba7069338ae0845ef31a15460b88e",
              "record_type": "offer",
              "status": "active"
            },
            "quantity": 1,
            "price": {
              "summary": {
                "headline": "<p>Headline</p>"
              },
              "currency": "USD",
              "amount": 75
            },
            "name": "$75 for 52 weeks then $31.96 every 4 weeks autorenew",
            "id": "bdc3cfb7-77b9-d8b8-7395-f44758ef1b29",
            "startDate": "2024-03-22",
            "products": [
              {
                "baseTemplate": "/config/templates/products/default",
                "entitlements": [
                  {
                    "$ref": "/entitlements/Digital"
                  }
                ],
                "path": "/products/Digital",
                "created": "2023-12-11T13:44:43+00:00",
                "modified": "2024-01-15T13:56:18+00:00",
                "attributes": {
                  "display_name__limio": "Digital",
                  "has_delivery__limio": false,
                  "product_code__limio": "LI.DIGITAL"
                },
                "record_type": "product",
                "lastSynced": "2024-03-12T16:00:35.232Z",
                "synced": true,
                "syncedFrom": "2c92c0f9778c090d0177aa4f357d043b"
              }
            ]
          }
        ],
        "process_immediately": true,
        "mode": "production",
        "total": {
          "currency": "USD",
          "amount": 75
        },
        "payment": {
          "type": "invoice",
          "invoicePref": "Email"
        },
        "customerDetails": {
          "lastName": "Last",
          "firstName": "First"
        },
        "sourceDetails": {
          "instance": "env.scratch.my.salesforce.com"
        },
        "initiated_source": "salesforce",
        "orderDate": "2024-03-22T12:13:28.026Z"
      },
      "status": "active",
      "record_type": "order",
      "owner": "id-39e4c3727b273ec4110b5769c10cdb52",
      "id": "order-db546637c354a63b0eeaa121a0c14f0b",
      "service": "limio",
      "created": "2024-03-22T12:13:29.455Z",
      "updated": "2024-03-22T12:13:29.972Z",
      "reference": "6RAHJ3FGQKL0",
      "mode": "production",
      "authority": {
        "aut": {
          "iss": "issuer.domain",
          "sub": "test@user.com"
        },
        "permissions": [
          "order:*"
        ]
      }
    }
  ]
}

Get Object By Name

get

Retrieve a Limio object using its name or external reference instead of the object ID (for example, to fetch a subscription by subscription number).

Authorizations

AuthorizationstringRequired

OAuth 2.0 Bearer token for authenticated API access. Required for order submission, object management, and administrative operations.

Obtain a token via the OAuth flow described in OAuth Bearer Token.

Pass the token in the Authorization header: Bearer <token>

Path parameters

servicestring · enumRequired

The service the object belongs to

Default: limioPossible values:

path_typestring · enumRequired

The type of object to operate on. Determines the shape of the response data and which fields are available.

Example: subscriptionsPossible values:

object_namestringRequired

The object name or external reference. For subscriptions this is typically the subscription number.

Example: 7BQKD1B2ASF0

Responses

200

application/json

401

application/json

502

application/json

get/objects/{service}/{path_type}/name/{object_name}

GET /api/objects/{service}/{path_type}/name/{object_name} HTTP/1.1
Host: your-environment.prod.limio.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "name": "3V053CN9SFIG",
  "start": "2024-03-22",
  "data": {
    "name": "$75 for 52 weeks then $31.96 every 4 weeks autorenew",
    "tracking": {
      "offers": [
        "/offers2/$75 for 52 weeks then $31.96 every 4 weeks autorenew"
      ],
      "purchaseCountryCode": "GB",
      "accountId": "0017x00000Q9O9qAAF",
      "zuoraAccountNumber": "A00001234",
      "contactId": "0037x00000F58M9AAJ",
      "userId": "0057x0000088Oh3AAE"
    },
    "offer": {
      "mode": "production",
      "path": "/offers2/$75 for 52 weeks then $31.96 every 4 weeks autorenew",
      "data": {
        "price__limio": [],
        "created": "2024-02-28T15:22:14+00:00",
        "duplicatedFrom": "/offers2/$75 for 52 weeks then $31.96 every 4 weeks autorenew",
        "type": "item",
        "version": "64e79ce3cbe2474c5b5fcbc5af229ec0d2439b12",
        "record_type": "offer",
        "productBundles": [
          {
            "revenue_split": "100",
            "product_path": "/products/Digital",
            "rate_plan": "$75 dollar per week"
          }
        ],
        "products": [
          {
            "baseTemplate": "/config/templates/products/default",
            "entitlements": [
              {
                "$ref": "/entitlements/Digital"
              }
            ],
            "path": "/products/Digital",
            "created": "2023-12-11T13:44:43+00:00",
            "modified": "2024-01-15T13:56:18+00:00",
            "attributes": {
              "display_name__limio": "Digital",
              "has_delivery__limio": false,
              "product_code__limio": "LI.DIGITAL"
            },
            "record_type": "product",
            "lastSynced": "2024-03-12T16:00:35.232Z",
            "synced": true,
            "syncedFrom": "2c92c0f9778c090d0177aa4f357d043b"
          }
        ],
        "baseTemplate": "/config/templates/offers/default",
        "path": "/offers2/$75 for 52 weeks then $31.96 every 4 weeks autorenew",
        "priceReference": "/offers2/$75 for 52 weeks then $31.96 every 4 weeks autorenew",
        "price": [],
        "name": "$75 for 52 weeks then $31.96 every 4 weeks autorenew",
        "modified": "2024-03-08T10:53:37+00:00",
        "attributes": {
          "checkout_description__limio": "<p>Description</p>",
          "price__limio": [
            {
              "delay_interval_type": "weeks",
              "name": "charge_1",
              "delay_interval": "2",
              "repeat_interval": 52,
              "attributes": [],
              "label": "Charge 1",
              "trigger": "order_date",
              "repeat_interval_type": "weeks",
              "repeat_count": 1,
              "type": "recurring",
              "value": "75.00",
              "currencyCode": "USD"
            }
          ],
          "default_quantity_options__limio": null,
          "supportBillingFrequencyChange__zuora": true,
          "allowed_countries__limio": [
            "AX"
          ],
          "label__limio": [
            "default"
          ],
          "term__limio": {
            "renewal_type": "EVERGREEN",
            "renewal_trigger": "EXTERNAL"
          },
          "display_price__limio": "<p>Display Price</p>",
          "cta_text__limio": "buy",
          "payment_types__limio": [
            "zuora_card"
          ],
          "sales_channel__limio": [
            "Online"
          ],
          "display_name__limio": "$75 for 52 weeks then $31.96 every 4 weeks autorenew 1",
          "checkout__limio": {
            "checkout_type": "standard"
          },
          "initial_term__limio": {
            "renewal_type": "TERMED",
            "length": 52,
            "renewal_trigger": "EXTERNAL",
            "type": "weeks"
          },
          "push_to_checkout__limio": true,
          "autoRenew__limio": true,
          "offer_type__limio": "standard"
        },
        "id": "998f6ca141d60006e1e239b9f4b4e725bf1615d3",
        "user": "user@domain.com"
      },
      "service": "limio",
      "created": "2024-03-12T17:30:40.337Z",
      "name": "$75 for 52 weeks then $31.96 every 4 weeks autorenew",
      "id": "998f6ca141d60006e1e239b9f4b4e725bf1615d3",
      "type": "item",
      "updated": "2024-03-12T17:30:40.337Z",
      "version": "121defc69da9962e4b78424234577aa7717f4daf",
      "record_type": "offer",
      "status": "active"
    },
    "quantity": 1,
    "termEndDate": "2025-03-21",
    "price": {
      "summary": {
        "headline": "<p>Display Price</p>"
      },
      "currency": "USD",
      "amount": 75
    },
    "termStartDate": "2024-03-22",
    "attributes": {
      "gift": false,
      "external": false
    },
    "id": "bdc3cfb7-77b9-d8b8-7395-f44758ef1b29",
    "purchaseCountry": "GB",
    "startDate": "2024-03-22",
    "products": [
      {
        "baseTemplate": "/config/templates/products/default",
        "entitlements": [
          {
            "$ref": "/entitlements/Digital"
          }
        ],
        "path": "/products/Digital",
        "created": "2023-12-11T13:44:43+00:00",
        "modified": "2024-01-15T13:56:18+00:00",
        "attributes": {
          "display_name__limio": "Digital",
          "has_delivery__limio": false,
          "product_code__limio": "LI.DIGITAL"
        },
        "record_type": "product",
        "lastSynced": "2024-03-12T16:00:35.232Z",
        "synced": true,
        "syncedFrom": "2c92c0f9778c090d0177aa4f357d043b"
      }
    ]
  },
  "status": "initial",
  "record_type": "subscription",
  "owner": "id-39e4c3727b273ec4110b5769c10cdb52",
  "customer": "cus-81f7a36b4737e4d07b56e89d392a4d6e",
  "id": "sub-7f0146cba78f9455e57875402643f103",
  "service": "limio",
  "ref": "order-db546637c354a63b0eeaa121a0c14f0b/bdc3cfb7-77b9-d8b8-7395-f44758ef1b29",
  "created": "2024-03-22T12:13:29.718Z",
  "updated": "2024-03-22T12:13:29.718Z",
  "reference": "3V053CN9SFIG",
  "mode": "production"
}

get

Retrieve all objects related to a specific object, identified by service, type, and ID. For example, fetch all related orders, payment methods, or schedules for a given subscription. Returns related objects across all record types. To filter by a specific record type, use the Get Object Relationships By Record Type endpoint instead.

Required scopes

This endpoint requires the following scopes:

Authorizations

AuthorizationstringRequired

OAuth 2.0 Bearer token for authenticated API access. Required for order submission, object management, and administrative operations.

Obtain a token via the OAuth flow described in OAuth Bearer Token.

Pass the token in the Authorization header: Bearer <token>

Path parameters

servicestring · enumRequired

The service the object belongs to

Default: limioPossible values:

path_typestring · enumRequired

The type of object to operate on. Determines the shape of the response data and which fields are available.

Example: subscriptionsPossible values:

idstringRequired

The unique identifier of the object. Format varies by object type (e.g. sub-... for subscriptions, cus-... for customers, order-... for orders, basket-... for baskets).

Example: sub-abcxyz123456

Query parameters

limitintegerOptional

Maximum number of related objects to return in one page. If omitted, all related objects up to the underlying query size limit are returned.

Example: 10

queryMorestringOptional

Retrieves the next page of results. Use the opaque queryMore token returned in the previous response, unchanged.

Example: eyJyZWxhdGVkUXVlcnlNb3JlIjoiYWJjMTIzIn0=

Responses

200

application/json

Related Objects

queryMorestringOptional

Base64-encoded pagination token. Pass it back in the queryMore query parameter to fetch the next page. Absent on the last page.

401

application/json

502

application/json

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

GET /api/objects/{service}/{path_type}/{id}/related HTTP/1.1
Host: your-environment.prod.limio.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "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",
            "data": {}
          },
          "to": {
            "name": "Limio Order",
            "id": "order-bcc1997b17b7824caf86b06451904fb8",
            "record_type": "order",
            "service": "limio",
            "data": {}
          },
          "metadata": {}
        }
      }
    }
  ],
  "queryMore": "text"
}

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.

Required scopes

This endpoint requires the following scopes:

Authorizations

AuthorizationstringRequired

OAuth 2.0 Bearer token for authenticated API access. Required for order submission, object management, and administrative operations.

Obtain a token via the OAuth flow described in OAuth Bearer Token.

Pass the token in the Authorization header: Bearer <token>

Path parameters

servicestring · enumRequired

The service the object belongs to

Default: limioPossible values:

idstringRequired

The unique identifier of the object. Format varies by object type (e.g. sub-... for subscriptions, cus-... for customers, order-... for orders, basket-... for baskets).

Example: sub-abcxyz123456

path_typestring · enumRequired

The type of object to operate on. Determines the shape of the response data and which fields are available.

Example: subscriptionsPossible values:

record_typestring · enumRequired

The record type of the object

Possible values:

Query parameters

limitintegerOptional

Maximum number of related objects to return in one page. If omitted, all related objects up to the underlying query size limit are returned.

Example: 10

queryMorestringOptional

Retrieves the next page of results. Use the opaque queryMore token returned in the previous response, unchanged.

Example: eyJyZWxhdGVkUXVlcnlNb3JlIjoiYWJjMTIzIn0=

Responses

200

application/json

Related Objects

queryMorestringOptional

Base64-encoded pagination token. Pass it back in the queryMore query parameter to fetch the next page. Absent on the last page.

401

application/json

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

GET /api/objects/{service}/{path_type}/{id}/related/{record_type} HTTP/1.1
Host: your-environment.prod.limio.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "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",
            "data": {}
          },
          "to": {
            "name": "Limio Order",
            "id": "order-bcc1997b17b7824caf86b06451904fb8",
            "record_type": "order",
            "service": "limio",
            "data": {}
          },
          "metadata": {}
        }
      }
    }
  ],
  "queryMore": "text"
}

post

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

Required scopes

This endpoint requires the following scopes:

Authorizations

AuthorizationstringRequired

OAuth 2.0 Bearer token for authenticated API access. Required for order submission, object management, and administrative operations.

Obtain a token via the OAuth flow described in OAuth Bearer Token.

Pass the token in the Authorization header: Bearer <token>

Path parameters

servicestring · enumRequired

The service the object belongs to

Default: limioPossible values:

idstringRequired

The unique identifier of the object. Format varies by object type (e.g. sub-... for subscriptions, cus-... for customers, order-... for orders, basket-... for baskets).

Example: sub-abcxyz123456

path_typestring · enumRequired

The type of object to operate on. Determines the shape of the response data and which fields are available.

Example: subscriptionsPossible values:

record_typestringRequired

Only identity is allowed

Default: identity

Body

Related Object Request

idstringOptional

The identity to which you want to link the object to

Example: identity-bcc1997b17b7824caf86b06451904fb8

servicestring · enumOptional

The service of the identity

Example: limioPossible values:

Responses

200

application/json

nullOptional

401

application/json

502

application/json

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

POST /api/objects/{service}/{path_type}/{id}/related/{record_type} HTTP/1.1
Host: your-environment.prod.limio.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 68

{
  "id": "identity-bcc1997b17b7824caf86b06451904fb8",
  "service": "limio"
}

No content

Get Child Objects

get

Retrieve all child objects of a parent object, identified by service, type, and ID. Returns children across all record types. Each child object includes a summary of its data — use the Get Object endpoint with the child's ID to fetch full details.

Required scopes

This endpoint requires the following scopes:

Authorizations

AuthorizationstringRequired

OAuth 2.0 Bearer token for authenticated API access. Required for order submission, object management, and administrative operations.

Obtain a token via the OAuth flow described in OAuth Bearer Token.

Pass the token in the Authorization header: Bearer <token>

Path parameters

servicestring · enumRequired

The service the object belongs to

Default: limioPossible values:

path_typestring · enumRequired

The type of object to operate on. Determines the shape of the response data and which fields are available.

Example: subscriptionsPossible values:

idstringRequired

The unique identifier of the object. Format varies by object type (e.g. sub-... for subscriptions, cus-... for customers, order-... for orders, basket-... for baskets).

Example: sub-abcxyz123456

Query parameters

sortstring · enumOptional

Sort direction of the results. Defaults to descending.

Example: ascPossible values:

excludestring · enumOptional

Omit child objects with the given status. Use cancelled to return only non-cancelled children, or active to return only non-active children.

Example: cancelledPossible values:

Responses

200

application/json

Children Objects

queryMorestringOptional

Pagination token. Present when more child objects exist beyond the current page; absent on the last page.

401

application/json

502

application/json

get/objects/{service}/{path_type}/{id}/objects

GET /api/objects/{service}/{path_type}/{id}/objects HTTP/1.1
Host: your-environment.prod.limio.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "items": [
    {
      "name": "Limio Subscription",
      "id": "e3535c52-3058-472e-aa4f-fe772a7c0f38",
      "related": "order-bcc1997b17b7824caf86b06451904fb8",
      "owner": "id-UshF1h62VLeKzukBmLGb59kU9c1Jn_hNewKngSrNXl8",
      "record_type": "subscription",
      "service": "limio",
      "mode": "production",
      "created": "2020-03-18T16:02:01.526Z",
      "data": {}
    }
  ],
  "queryMore": "text"
}

Get Child Objects by Record Type

get

Retrieve child objects of a specific record type from a parent object. Similar to Get Child Objects, but filtered to only return children matching the specified subtype (e.g. only order children of a subscription). Each child object includes a summary of its data.

Required scopes

This endpoint requires the following scopes:

Authorizations

AuthorizationstringRequired

OAuth 2.0 Bearer token for authenticated API access. Required for order submission, object management, and administrative operations.

Obtain a token via the OAuth flow described in OAuth Bearer Token.

Pass the token in the Authorization header: Bearer <token>

Path parameters

servicestring · enumRequired

The service the object belongs to

Default: limioPossible values:

path_typestring · enumRequired

The type of object to operate on. Determines the shape of the response data and which fields are available.

Example: subscriptionsPossible values:

idstringRequired

The unique identifier of the object. Format varies by object type (e.g. sub-... for subscriptions, cus-... for customers, order-... for orders, basket-... for baskets).

Example: sub-abcxyz123456

subtypestring · enumRequired

The record type of the child objects to retrieve.

Example: orderPossible values:

Query parameters

sortstring · enumOptional

Sort direction of the results. Defaults to descending.

Example: ascPossible values:

excludestring · enumOptional

Omit child objects with the given status. Use cancelled to return only non-cancelled children, or active to return only non-active children.

Example: cancelledPossible values:

Responses

200

application/json

Children Objects

queryMorestringOptional

Pagination token. Present when more child objects exist beyond the current page; absent on the last page.

401

application/json

502

application/json

get/objects/{service}/{path_type}/{id}/objects/{subtype}

GET /api/objects/{service}/{path_type}/{id}/objects/{subtype} HTTP/1.1
Host: your-environment.prod.limio.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "items": [
    {
      "name": "Limio Subscription",
      "id": "e3535c52-3058-472e-aa4f-fe772a7c0f38",
      "related": "order-bcc1997b17b7824caf86b06451904fb8",
      "owner": "id-UshF1h62VLeKzukBmLGb59kU9c1Jn_hNewKngSrNXl8",
      "record_type": "subscription",
      "service": "limio",
      "mode": "production",
      "created": "2020-03-18T16:02:01.526Z",
      "data": {}
    }
  ],
  "queryMore": "text"
}

Get Object Events

get

Retrieve the event history for a specific object. Events represent actions that have been performed on or related to the object, such as creation, updates, offer changes, or cancellations. Commonly used to build an audit trail or activity log for subscriptions.

Required scopes

This endpoint requires the following scopes:

Authorizations

AuthorizationstringRequired

OAuth 2.0 Bearer token for authenticated API access. Required for order submission, object management, and administrative operations.

Obtain a token via the OAuth flow described in OAuth Bearer Token.

Pass the token in the Authorization header: Bearer <token>

Path parameters

servicestring · enumRequired

The service the object belongs to

Default: limioPossible values:

path_typestring · enumRequired

The type of object to operate on. Determines the shape of the response data and which fields are available.

Example: subscriptionsPossible values:

idstringRequired

The unique identifier of the object. Format varies by object type (e.g. sub-... for subscriptions, cus-... for customers, order-... for orders, basket-... for baskets).

Example: sub-abcxyz123456

Query parameters

limitintegerOptional

Maximum number of events to return in one page. If omitted, all events up to the underlying query size limit are returned.

Example: 10

queryMorestringOptional

Accepted as the queryMore token from a previous response. Note that this endpoint does not currently apply the token, so the first page of events is always returned.

Example: eyJoYXNoIjoic3ByaW50LTk2L3Byb2R1Y3Rpb24ifQ==

Responses

200

application/json

queryMorestringOptional

Pagination token. Present when more events exist beyond the returned page.

Example: eyJoYXNoIjoic3ByaW50LTk2L3Byb2R1Y3Rpb24ifQ==

401

application/json

502

application/json

get/objects/{service}/{path_type}/{id}/events

GET /api/objects/{service}/{path_type}/{id}/events HTTP/1.1
Host: your-environment.prod.limio.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "items": [
    {
      "record_type": "event",
      "id": "event-64ad4e5eab8a9288e379a1e059c0d3ee",
      "relationship_id": "rel-344856c1b0d4f64c4f8738bd1758ea0b",
      "data": {
        "message": "Order Received",
        "type": "order.change_address",
        "source": "shop"
      },
      "related": "order-bcd2d53ebd5066d8fc644507ed5f1cdf",
      "service": "limio",
      "mode": "production",
      "created": "2024-02-13T14:20:24.608Z",
      "status": "submitted"
    }
  ],
  "unpackedItems": [
    {
      "mode": "production",
      "status": "sprint-96/production/limio/active",
      "created": "2024-02-13T14:20:24.608Z",
      "sort_key": "rel/object/order/limio/order-bcd2d53ebd5066d8fc644507ed5f1cdf/event/limio/event-64ad4e5eab8a9288e379a1e059c0d3ee",
      "related": "sprint-96/production/limio/order-bcd2d53ebd5066d8fc644507ed5f1cdf",
      "reference": "1K91BC3C6KUO",
      "service": "limio",
      "hash": "sprint-96/production/limio/event-64ad4e5eab8a9288e379a1e059c0d3ee",
      "updated": "2024-02-13T14:20:24.608Z",
      "header": {
        "from": {
          "id": "limio/event-64ad4e5eab8a9288e379a1e059c0d3ee",
          "data": {
            "message": "Order Received",
            "type": "order.change_address",
            "source": "shop"
          },
          "record_type": "event",
          "service": "limio",
          "status": "submitted"
        },
        "metadata": {},
        "to": {
          "name": "34LL75TASAIG",
          "id": "limio/order-bcd2d53ebd5066d8fc644507ed5f1cdf",
          "data": {},
          "record_type": "order",
          "service": "limio",
          "status": "active"
        }
      },
      "tenant_id": "sprint-96",
      "processName": "unknown/1/8/8eafcaaa-c04c-47d9-abfe-3e4dc381fe4c",
      "id": "limio/rel-344856c1b0d4f64c4f8738bd1758ea0b",
      "record_type": "sprint-96/production/limio/rel",
      "body": {}
    }
  ],
  "queryMore": "eyJoYXNoIjoic3ByaW50LTk2L3Byb2R1Y3Rpb24ifQ=="
}

PreviousObjects API

NextSubscriptions

Last updated 2 hours ago

Was this helpful?

Get Object

Update Object

Delete Object

Get Objects

Get Object By Name

Get Object Relationships

Get Object Relationships By Record Type

Add Object Relationship

Get Child Objects

Get Child Objects by Record Type

Get Object Events