Get Objects

APIs related to retrieving Limio Objects

Get Object

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.

SecuritybearerAuth

Request

path Parameters

service required	string Default: "limio" The service the object belongs to Enum: "limio" "zuora" "salesforce"
path_type required	string Enum: "orders" "customers" "subscriptions" "identities" "address" "schedules" "payment_methods" "subscription_offers" "user_entitlements" "gift_code" "promo_codes_v2" "events" "process"
id required	string Example: sub-abcxyz123456

Responses

200

401

Unauthorized

502

Bad Gateway

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

Request samples

curl
JavaScript
Python

Response samples

application/json

{"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",
"contactId": "0037x00000F58M9AAJ",
"userId": "0057x0000088Oh3AAE"
},
"offer": {"mode": "production",
"path": "/offers2/$75 for 52 weeks then $31.96 every 4 weeks autorenew",
"data": {"price__limio": [null
],
"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": null
}
],
"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": [null
],
"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": [null
],
"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 Objects

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.

SecuritybearerAuth

Request

path Parameters

service required	string Default: "limio" The service the object belongs to Enum: "limio" "zuora" "salesforce"
path_type required	string Enum: "orders" "customers" "subscriptions" "identities" "address" "schedules" "payment_methods" "subscription_offers" "user_entitlements" "gift_code" "promo_codes_v2" "events" "process"

query Parameters

limit	number The number of objects to return. Example: limit=10
queryMore	string Retrieves the next page of results. Use the queryMore returned in the previous response. Example: queryMore=DnF1ZXJ5VGhlbkZldGNoBQAAAAAAGH

Responses

200

401

Unauthorized

502

Bad Gateway

get/objects/{service}/{path_type}

Request samples

curl
JavaScript
Python

Response samples

application/json

{"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",
"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": null,
"duplicatedFrom": null,
"type": null,
"version": null,
"record_type": null,
"productBundles": [ ],
"products": [ ],
"baseTemplate": null,
"path": null,
"priceReference": null,
"price": [ ],
"name": null,
"modified": null,
"attributes": { },
"id": null,
"user": null
},
"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": null
},
"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": null,
"entitlements": [ ],
"path": null,
"created": null,
"modified": null,
"attributes": null,
"record_type": null,
"lastSynced": null,
"synced": null,
"syncedFrom": null
}
]
}
],
"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:*"
]
}
}
],
"queryMore": "eyJjcmVhdGVkIjoiMjAyNC0wMy0wMVQwMTozNjowOC43MjVaIiwic29ydF9rZXkiOiJvYmplY3Qvc3Vic2NyaXB0aW9uIiwiaGFzaCI6ImVjb25vbWlzdC1iYXUtcHJlcHJvZC9wcm9kdWN0aW9uL2xpbWlvL3N1Yi02YjExOTliOTkzYTQyNDdmZDgwNTRlMWFkNzZiOGVjOSIsInJlY29yZF90eXBlIjoiZWNvbm9taXN0LWJhdS1wcmVwcm9kL3Byb2R1Y3Rpb24vbGltaW8vc3Vic2NyaXB0aW9uIn0="
}

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.

SecuritybearerAuth

Request

path Parameters

service required	string Default: "limio" The service the object belongs to Enum: "limio" "zuora" "salesforce"
path_type required	string Enum: "orders" "customers" "subscriptions" "identities" "address" "schedules" "payment_methods" "subscription_offers" "user_entitlements" "gift_code" "promo_codes_v2" "events" "process"
id required	string Example: sub-abcxyz123456

Responses

200

401

Unauthorized

502

Bad Gateway

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

Request samples

curl
JavaScript
Python

Response samples

application/json

{"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": { }
}
}
}
]
}

Get Object Relationships By Record Type

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.

SecuritybearerAuth

Request

path Parameters

service required	string Default: "limio" The service the object belongs to Enum: "limio" "zuora" "salesforce"
id required	string Example: sub-abcxyz123456
path_type required	string Enum: "orders" "customers" "subscriptions" "identities" "address" "schedules" "payment_methods" "subscription_offers" "user_entitlements" "gift_code" "promo_codes_v2" "events" "process"
record_type required	string The record type of the object Enum: "offer" "order" "customer" "gift_code" "promo_code" "identity" "schedule" "subscription_offer" "payment_method" "rate_plan" "entitlement" "product"

Responses

200

401

Unauthorized

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

Request samples

curl
JavaScript
Python

Response samples

application/json

{"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": { }
}
}
}
]
}

Get Object Subtype

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.

SecuritybearerAuth

Request

path Parameters

service required	string Default: "limio" The service the object belongs to Enum: "limio" "zuora" "salesforce"
path_type required	string Enum: "orders" "customers" "subscriptions" "identities" "address" "schedules" "payment_methods" "subscription_offers" "user_entitlements" "gift_code" "promo_codes_v2" "events" "process"
id required	string Example: sub-abcxyz123456

Responses

200

401

Unauthorized

502

Bad Gateway

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

Request samples

curl
JavaScript
Python

Response samples

application/json

{"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": { }
}
]
}

Get Object Subtype By Record Type

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.

SecuritybearerAuth

Request

path Parameters

service required	string Default: "limio" The service the object belongs to Enum: "limio" "zuora" "salesforce"
path_type required	string Enum: "orders" "customers" "subscriptions" "identities" "address" "schedules" "payment_methods" "subscription_offers" "user_entitlements" "gift_code" "promo_codes_v2" "events" "process"
id required	string Example: sub-abcxyz123456
subtype	string The subtype of an object Enum: "offer" "order" "customer" "gift_code" "promo_code" "identity" "schedule" "subscription_offer" "payment_method" "rate_plan" "entitlement" "product"

Responses

200

401

Unauthorized

502

Bad Gateway

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

Request samples

curl
JavaScript
Python

Response samples

application/json

{"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": { }
}
]
}

Get Object Events

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.

SecuritybearerAuth

Request

path Parameters

service required	string Default: "limio" The service the object belongs to Enum: "limio" "zuora" "salesforce"
path_type required	string Enum: "orders" "customers" "subscriptions" "identities" "address" "schedules" "payment_methods" "subscription_offers" "user_entitlements" "gift_code" "promo_codes_v2" "events" "process"
id required	string Example: sub-abcxyz123456

Responses

200

401

Unauthorized

502

Bad Gateway

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

Request samples

curl
JavaScript
Python

Response samples

application/json

{"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": { }
}
]
}

➔ Next to Create Objects