# 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

> 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.

```json
{"openapi":"3.1.0","info":{"title":"Limio Commerce API","version":"1.0.0"},"tags":[{"name":"Objects","description":"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."}],"servers":[{"url":"https://{tenant}/api","description":"Limio environment API","variables":{"tenant":{"default":"your-environment.prod.limio.com","description":"Your Limio environment hostname, e.g. `acme.prod.limio.com` or `acme-sandbox.prod.limio.com`."}}}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"OAuth 2.0 Bearer token for authenticated API access. Required for order submission, object management, and administrative operations.\n\nObtain a token via the OAuth flow described in [OAuth Bearer Token](https://docs.limio.com/developers/api-documentation/authentication-overview/oauth-bearer-token).\n\nPass the token in the `Authorization` header: `Bearer <token>`"}},"schemas":{"GetSubscriptionObjectResponse":{"type":"object","description":"Subscription object","title":"Get Subscription Response","properties":{"name":{"type":"string","description":"Subscription name"},"start":{"type":"string","format":"date","description":"Subscription start date"},"data":{"type":"object","description":"Subscription data","properties":{"name":{"type":"string","description":"Subscription data name"},"tracking":{"$ref":"#/components/schemas/Tracking"},"offer":{"type":"object","description":"Offer details","properties":{"mode":{"type":"string"},"path":{"type":"string"},"data":{"$ref":"#/components/schemas/OfferData"},"service":{"type":"string"},"created":{"type":"string","format":"date-time"},"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"updated":{"type":"string","format":"date-time"},"version":{"type":"string"},"record_type":{"type":"string"},"status":{"type":"string"}}},"quantity":{"type":"integer"},"termEndDate":{"type":"string","format":"date"},"price":{"type":"object","description":"Price details","properties":{"summary":{"type":"object","properties":{"headline":{"type":"string"}}},"currency":{"type":"string"},"amount":{"type":"number"}}},"termStartDate":{"type":"string","format":"date"},"attributes":{"type":"object","properties":{"gift":{"type":"boolean"},"external":{"type":"boolean"}}},"id":{"type":"string"},"purchaseCountry":{"type":"string"},"startDate":{"type":"string","format":"date"},"products":{"type":"array","items":{"$ref":"#/components/schemas/ProductDetails"}}}},"status":{"type":"string"},"record_type":{"type":"string"},"owner":{"type":"string"},"customer":{"type":"string"},"id":{"type":"string"},"service":{"type":"string"},"ref":{"type":"string"},"created":{"type":"string","format":"date-time"},"updated":{"type":"string","format":"date-time"},"reference":{"type":"string"},"mode":{"type":"string"}}},"Tracking":{"type":"object","description":"Tracking data associated with the order, used for attribution and integration with external systems. When `accountId` is provided, the basket is assigned an owner and the response includes an `assistedCheckoutLink` for OBO (On-Behalf-Of) checkout flows.","properties":{"offers":{"type":"array","items":{"type":"string"}},"purchaseCountryCode":{"type":"string"},"accountId":{"type":"string","description":"Salesforce Account ID. When provided, Limio resolves or creates an identity owner for the basket and returns an `assistedCheckoutLink` in the response."},"contactId":{"type":"string","description":"Salesforce Contact ID associated with this order."},"userId":{"type":"string","description":"Salesforce User ID associated with this order."}}},"OfferData":{"type":"object","properties":{"price__limio":{"type":"array","items":{}},"created":{"type":"string","format":"date-time"},"duplicatedFrom":{"type":"string"},"type":{"type":"string"},"version":{"type":"string"},"record_type":{"type":"string"},"productBundles":{"type":"array","items":{"type":"object","properties":{"revenue_split":{"type":"string"},"product_path":{"type":"string"},"rate_plan":{"type":"string"}}}},"products":{"type":"array","items":{"$ref":"#/components/schemas/ProductDetails"}},"baseTemplate":{"type":"string"},"path":{"type":"string"},"priceReference":{"type":"string"},"price":{"type":"array","items":{}},"name":{"type":"string"},"modified":{"type":"string","format":"date-time"},"attributes":{"type":"object","properties":{"checkout_description__limio":{"type":"string"},"price__limio":{"type":"array","items":{"type":"object","properties":{"delay_interval_type":{"type":"string"},"name":{"type":"string"},"delay_interval":{"type":"string"},"repeat_interval":{"type":"integer"},"attributes":{"type":"array","items":{}},"label":{"type":"string"},"trigger":{"type":"string"},"repeat_interval_type":{"type":"string"},"repeat_count":{"type":"integer"},"type":{"type":"string"},"value":{"type":"string"},"currencyCode":{"type":"string"}}}},"default_quantity_options__limio":{},"supportBillingFrequencyChange__zuora":{"type":"boolean"},"allowed_countries__limio":{"type":"array","items":{"type":"string"}},"label__limio":{"type":"array","items":{"type":"string"}},"term__limio":{"type":"object","properties":{"renewal_type":{"type":"string"},"renewal_trigger":{"type":"string"}}},"display_price__limio":{"type":"string"},"cta_text__limio":{"type":"string"},"payment_types__limio":{"type":"array","items":{"type":"string"}},"sales_channel__limio":{"type":"array","items":{"type":"string"}},"display_name__limio":{"type":"string"},"checkout__limio":{"type":"object","properties":{"checkout_type":{"type":"string"}}},"initial_term__limio":{"type":"object","properties":{"renewal_type":{"type":"string"},"length":{"type":"integer"},"renewal_trigger":{"type":"string"},"type":{"type":"string"}}},"push_to_checkout__limio":{"type":"boolean"},"autoRenew__limio":{"type":"boolean"},"offer_type__limio":{"type":"string"}}},"id":{"type":"string"},"user":{"type":"string"}}},"ProductDetails":{"type":"object","properties":{"baseTemplate":{"type":"string"},"entitlements":{"type":"array","items":{"$ref":"#/components/schemas/Entitlement"}},"path":{"type":"string"},"created":{"type":"string","format":"date-time"},"modified":{"type":"string","format":"date-time"},"attributes":{"$ref":"#/components/schemas/ProductAttributes"},"record_type":{"type":"string"},"lastSynced":{"type":"string","format":"date-time"},"synced":{"type":"boolean"},"syncedFrom":{"type":"string"}}},"Entitlement":{"type":"object","properties":{"$ref":{"type":"string"}}},"ProductAttributes":{"type":"object","properties":{"display_name__limio":{"type":"string"},"has_delivery__limio":{"type":"boolean"},"product_code__limio":{"type":"string"}}},"GetCustomerObjectResponse":{"type":"object","description":"Customer object","title":"Get Customer Response","properties":{"data":{"type":"object","description":"Customer data","properties":{"name":{"type":"string","description":"Full name of the customer"},"email":{"type":"string","format":"email","description":"Email address of the customer"},"firstName":{"type":"string","description":"First name of the customer"},"lastName":{"type":"string","description":"Last name of the customer"},"purchaseCountry":{"type":"string","description":"Country code of the customer's purchase"},"trialist":{"type":"boolean","description":"Indicates if the customer is a trialist"}}},"status":{"type":"string","description":"Status of the customer"},"record_type":{"type":"string","description":"Record type of the object"},"owner":{"type":"string","description":"ID of the owner of the customer"},"id":{"type":"string","description":"Unique identifier of the customer"},"service":{"type":"string","description":"Service associated with the customer"},"created":{"type":"string","format":"date-time","description":"Timestamp of when the customer was created"},"updated":{"type":"string","format":"date-time","description":"Timestamp of when the customer was last updated"},"reference":{"type":"string","description":"Reference code associated with the customer"},"mode":{"type":"string","description":"Mode of the customer object"}}},"GetOrderObjectResponse":{"type":"object","description":"Order object","title":"Get Order Response","properties":{"name":{"type":"string","description":"Order name"},"data":{"type":"object","description":"Order data","properties":{"email":{"type":"string"},"name":{"type":"string"},"tracking":{"$ref":"#/components/schemas/Tracking"},"country":{"type":"string"},"billingDetails":{"$ref":"#/components/schemas/BillingDetails"},"__spec_version":{"type":"string"},"external_id":{"type":"string"},"source":{"type":"string","enum":["salesforce","limio"]},"orderItems":{"type":"array","items":{"$ref":"#/components/schemas/OrderItem"}},"process_immediately":{"type":"boolean"},"mode":{"type":"string"},"total":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"integer"}}},"payment":{"type":"object","properties":{"type":{"type":"string"},"invoicePref":{"type":"string"}}},"customerDetails":{"type":"object","properties":{"lastName":{"type":"string"},"firstName":{"type":"string"}}},"sourceDetails":{"type":"object","properties":{"instance":{"type":"string"}}},"initiated_source":{"type":"string"},"orderDate":{"type":"string","format":"date-time"}}},"status":{"type":"string"},"record_type":{"type":"string"},"owner":{"type":"string"},"id":{"type":"string"},"service":{"type":"string"},"created":{"type":"string","format":"date-time"},"updated":{"type":"string","format":"date-time"},"reference":{"type":"string"},"mode":{"type":"string"},"authority":{"type":"object","properties":{"aut":{"type":"object","properties":{"iss":{"type":"string"},"sub":{"type":"string"}}},"permissions":{"type":"array","items":{"type":"string"}}}}}},"BillingDetails":{"type":"object","properties":{"country":{"type":"string"},"firstName":{"type":"string"},"lastName":{"type":"string"},"streetName":{"type":"string"},"city":{"type":"string"},"address1":{"type":"string"},"address2":{"type":"string"},"postalCode":{"type":"string"},"buildingNumber":{"type":"number"},"company":{"type":"string"},"state":{"type":"string"}}},"OrderItem":{"type":"object","properties":{"offer":{"$ref":"#/components/schemas/Offer"},"quantity":{"type":"integer"},"price":{"type":"object","properties":{"summary":{"type":"object","properties":{"headline":{"type":"string"}}},"currency":{"type":"string"},"amount":{"type":"integer"}}},"name":{"type":"string"},"id":{"type":"string"},"startDate":{"type":"string","format":"date"},"products":{"type":"array","items":{"$ref":"#/components/schemas/ProductDetails"}}}},"Offer":{"type":"object","description":"A Limio offer object representing a purchasable subscription offer with pricing, products, and configuration.","properties":{"mode":{"type":"string","description":"Deployment mode of the offer.","enum":["production","test"]},"path":{"type":"string","description":"Catalog path of the offer. V2 offers use `/offers2/...`, legacy offers use `/offers/...`."},"data":{"$ref":"#/components/schemas/OfferData"},"service":{"type":"string","description":"The service this offer belongs to."},"created":{"type":"string","format":"date-time","description":"Timestamp when the offer was created."},"name":{"type":"string","description":"Display name of the offer."},"id":{"type":"string","description":"Unique offer identifier (content-addressable hash)."},"type":{"type":"string","description":"Object type within the catalog hierarchy."},"updated":{"type":"string","format":"date-time","description":"Timestamp when the offer was last modified."},"version":{"type":"string","description":"Version hash of the offer. Changes when the offer content is updated. Used with the Published Offers API for versioned offer management."},"record_type":{"type":"string","description":"Object type identifier. Always `offer` for this schema."},"status":{"type":"string","description":"Publication status of the offer.","enum":["active","inactive"]}}},"GetIdentityObjectResponse":{"type":"object","description":"Identity object","title":"Get Identity Response","properties":{"data":{"type":"object","description":"Identity data","properties":{"email":{"type":"string","format":"email"},"cognito:username":{"type":"string"},"email_verified":{"type":"boolean"},"event_id":{"type":"string"},"isValidated":{"type":"boolean"},"iss":{"type":"string"},"jti":{"type":"string"},"origin_jti":{"type":"string"},"sub":{"type":"string"}}},"status":{"type":"string"},"record_type":{"type":"string"},"record_variant":{"type":"string"},"owner":{"type":"string"},"id":{"type":"string"},"service":{"type":"string"},"created":{"type":"string","format":"date-time"},"updated":{"type":"string","format":"date-time"},"mode":{"type":"string"}}},"CustomerAddress":{"type":"object","description":"Customer Address object","title":"Get Customer Address Response","properties":{"record_type":{"type":"string"},"id":{"type":"string"},"relationship_id":{"type":"string"},"data":{"type":"object","properties":{"firstName":{"type":"string"},"lastName":{"type":"string"},"country":{"type":"string"},"address2":{"type":"string"},"city":{"type":"string"},"address1":{"type":"string"},"postalCode":{"type":"string"},"company":{"type":"string"},"state":{"type":"string"},"email":{"type":"string","format":"email"}}},"related":{"type":"string"},"service":{"type":"string"},"start":{"type":"string","format":"date-time"},"relationship_type":{"type":"string"},"mode":{"type":"string"},"created":{"type":"string","format":"date-time"},"status":{"type":"string"},"owner":{"type":"string"},"customer":{"type":"string"},"updated":{"type":"string","format":"date-time"},"reference":{"type":"string"}}},"GetScheduleObjectResponse":{"type":"object","description":"Schedule object","title":"Get Schedule Response","properties":{"data":{"type":"object","description":"Schedule data","properties":{"date":{"type":"string","format":"date-time"},"amountWithoutTax":{"type":"string"},"lineItems":{"type":"array","items":{"type":"object","properties":{"amountWithoutTax":{"type":"string"},"processingType":{"type":"string"},"quantity":{"type":"integer"},"taxAmount":{"type":"string"},"chargeName":{"type":"string"},"productName":{"type":"string"},"chargeDescription":{"type":"string"}}}},"amount":{"type":"string"},"quantity":{"type":"integer"},"description":{"type":"string"},"currency":{"type":"string"},"unit_amount":{"type":"string"},"schedule_date":{"type":"string","format":"date-time"},"type":{"type":"string"},"taxAmount":{"type":"integer"}}},"status":{"type":"string"},"record_type":{"type":"string"},"related":{"type":"string"},"owner":{"type":"string"},"id":{"type":"string"},"service":{"type":"string"},"created":{"type":"string","format":"date-time"},"updated":{"type":"string","format":"date-time"},"reference":{"type":"string"},"mode":{"type":"string"}}},"GetPaymentMethodObjectResponse":{"type":"object","description":"Payment Method object","title":"Get Payment Method Response","properties":{"type":{"type":"string"},"data":{"type":"object","description":"Payment method data","properties":{"type":{"type":"string"},"zuora":{"type":"object","properties":{"result":{"type":"object","properties":{"LastTransactionDateTime":{"type":"string","format":"date-time"},"LastTransactionStatus":{"type":"string"},"NumConsecutiveFailures":{"type":"integer"},"UpdatedDate":{"type":"string","format":"date-time"},"UpdatedById":{"type":"string"},"CreditCardExpirationMonth":{"type":"integer"},"CreditCardExpirationYear":{"type":"integer"},"CreditCardType":{"type":"string"},"CreditCardHolderName":{"type":"string"},"PaymentMethodStatus":{"type":"string"},"Active":{"type":"boolean"},"Type":{"type":"string"},"CreatedById":{"type":"string"},"CreditCardMaskNumber":{"type":"string"},"CreatedDate":{"type":"string","format":"date-time"},"BankIdentificationNumber":{"type":"string"},"IsCompany":{"type":"boolean"},"TotalNumberOfErrorPayments":{"type":"integer"},"Id":{"type":"string"},"TotalNumberOfProcessedPayments":{"type":"integer"},"UseDefaultRetryRule":{"type":"boolean"}}},"signature":{"type":"string"},"success":{"type":"boolean"},"tenantId":{"type":"string"},"responseFrom":{"type":"string"},"refId":{"type":"string"},"paymentGateway":{"type":"string"},"token":{"type":"string"}}},"timing":{"type":"object","properties":{"delta":{"type":"integer"}}},"address":{"type":"object","properties":{"country":{"type":"string"},"firstName":{"type":"string"},"lastName":{"type":"string"},"streetName":{"type":"string"},"address2":{"type":"string"},"city":{"type":"string"},"address1":{"type":"string"},"postalCode":{"type":"string"},"buildingNumber":{"type":"string"},"company":{"type":"string"},"state":{"type":"string"}}}}},"status":{"type":"string"},"record_type":{"type":"string"},"related":{"type":"string"},"owner":{"type":"string"},"customer":{"type":"string"},"id":{"type":"string"},"service":{"type":"string"},"created":{"type":"string","format":"date-time"},"updated":{"type":"string","format":"date-time"},"reference":{"type":"string"},"mode":{"type":"string"}}},"GetPromoCodeV2ObjectResponse":{"type":"object","description":"Promo Code V2 object","title":"Get Promo Code V2 Response","properties":{"name":{"type":"string","description":"Promo code name"},"data":{"$ref":"#/components/schemas/PromoCodeData"},"status":{"type":"string"},"record_type":{"type":"string"},"id":{"type":"string"},"service":{"type":"string"},"created":{"type":"string","format":"date-time"},"updated":{"type":"string","format":"date-time"},"mode":{"type":"string"}}},"PromoCodeData":{"type":"object","properties":{"promoCode":{"type":"string","description":"The object 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"},"status":{"type":"boolean","description":"Sets the status of the promo code. If true, the promo code is active. If false, the promo code is inactive."},"description":{"type":"string","description":"A brief description of the promo code."},"promoStartDate":{"type":"string","format":"date","description":"The start date for the promo code. If no start date is provided, the promo code will be active immediately providing the status is set to active."},"promoExpiryDate":{"type":"string","format":"date","description":"The expiry date for the promo code. If no expiry date is provided, the promo code will be active indefinitely."},"productDetails":{"$ref":"#/components/schemas/PromoCodeProductDetails"},"usage":{"type":"object","properties":{"availableQuantity":{"type":"number","description":"The number of times the promo code can be used. If undefined, the promo code can be used an unlimited number of times."}}},"discount":{"type":"object","oneOf":[{"title":"Discount Type Percentage","properties":{"discountType":{"type":"string","const":"DiscountPercentage"},"percentageDiscount":{"type":"number","description":"The percentage discount. Can be specified to 2 decimal places. This should only be set if the discountType is DiscountPercentage."},"durationLength":{"type":"integer","description":"The duration length of the discount."},"durationType":{"type":"string","enum":["Days","Weeks","Months","Years"],"description":"The duration type (e.g., months)."}}},{"title":"Discount Type Fixed Amount","properties":{"discountType":{"type":"string","const":"DiscountFixedAmount"},"amountDiscount":{"type":"number","description":"The amount discount. Can be specified to 2 decimal places. This should only be set if the discountType is DiscountFixedAmount."},"currency":{"type":"string","description":"The currency of the discount. Remember to activate the associated currency of the rate plan in the billing system."},"durationLength":{"type":"integer","description":"The duration length of the discount."},"durationType":{"type":"string","enum":["Days","Weeks","Months","Years"],"description":"The duration type (e.g., months)."}}}]}},"required":["promoCode","status","productDetails","discount"]},"PromoCodeProductDetails":{"type":"object","properties":{"product":{"type":"object","properties":{"path":{"type":"string","description":"Path to the Limio Product."}}},"ratePlan":{"type":"object","properties":{"path":{"type":"string","description":"The name of the rate plan. This rate plan should exist in the product specified. Its type should match the discount type specified in the payload"}}}},"required":["product","ratePlan"]},"GetPromoCodeV3ObjectResponse":{"type":"object","description":"Promo Code V3 object","title":"Get Promo Code V3 Response","properties":{"name":{"type":"string","description":"Promo code name"},"data":{"$ref":"#/components/schemas/PromoCodeV3Data"},"status":{"type":"string"},"record_type":{"type":"string"},"id":{"type":"string"},"service":{"type":"string"},"created":{"type":"string","format":"date-time"},"updated":{"type":"string","format":"date-time"},"mode":{"type":"string"}}},"PromoCodeV3Data":{"type":"object","required":["promoCode","status"],"properties":{"promoCode":{"type":"string","description":"The promo code string that customers enter at checkout."},"status":{"type":"boolean","description":"Whether the promo code is active. When `true` the code can be redeemed; when `false` it is disabled."},"description":{"type":"string","description":"A brief description of the promo code."},"promoStartDate":{"type":"string","format":"date","description":"The date the promo code becomes redeemable (YYYY-MM-DD). If omitted the code is active immediately (when status is true)."},"promoExpiryDate":{"type":"string","format":"date","description":"The date the promo code expires (YYYY-MM-DD). If omitted the code does not expire."},"usage":{"type":"object","properties":{"availableQuantity":{"type":"integer","description":"Maximum number of times this code can be redeemed. If omitted the code has unlimited uses."},"redeemedQuantity":{"type":"integer","description":"Number of times the code has been redeemed so far."}}},"attachedDiscount":{"type":"object","description":"Reference to the discount catalog item that defines the pricing rules applied when this code is redeemed.","required":["id","path","name"],"properties":{"id":{"type":"string","description":"The Elasticsearch document ID of the discount."},"path":{"type":"string","description":"The catalog path of the discount."},"name":{"type":"string","description":"Display name of the discount."}}}}},"GetSubscriptionOfferObjectResponse":{"type":"object","description":"Subscription Offer object","title":"Get Subscription Offer Response","properties":{"data":{"type":"object","description":"Subscription Offer data","properties":{"name":{"type":"string"},"start":{"type":"string","format":"date-time"},"price":{"type":"object","description":"Price details","properties":{"summary":{"type":"object"},"currency":{"type":"string"},"amount":{"type":"number"}}},"offer":{"$ref":"#/components/schemas/Offer"},"quantity":{"type":"integer"},"details":{"type":"string"},"id":{"type":"string"},"tracking":{"type":"object","properties":{"offers":{"type":"array","items":{"type":"string"}},"lmo_offer":{"type":"string"},"campaign":{"type":"string"},"tag":{"type":"string"}}},"products":{"type":"array","items":{"type":"object","properties":{"baseTemplate":{"type":"string"},"entitlements":{"type":"array","items":{"type":"object","properties":{"$ref":{"type":"string"}}}},"path":{"type":"string"},"created":{"type":"string","format":"date-time"},"modified":{"type":"string","format":"date-time"},"attributes":{"type":"object","properties":{"display_name__limio":{"type":"string"},"Product Family":{"type":"string"},"product_code__limio":{"type":"string"}}},"record_subtype":{"type":"null"},"record_type":{"type":"string"}}}}}},"status":{"type":"string"},"record_type":{"type":"string"},"related":{"type":"string"},"owner":{"type":"string"},"customer":{"type":"string"},"id":{"type":"string"},"service":{"type":"string"},"created":{"type":"string","format":"date-time"},"updated":{"type":"string","format":"date-time"},"reference":{"type":"string"},"mode":{"type":"string"}}},"GetUserEntitlementObjectResponse":{"type":"object","description":"Entitlement object","title":"Get User Entitlement Response","properties":{"from":{"type":"string"},"code":{"type":"string"},"type":{"type":"string"},"endDate":{"type":"string","format":"date"},"startDate":{"type":"string","format":"date-time"},"effectiveDate":{"type":"string","format":"date-time"}}}},"responses":{"401Response":{"description":"Unauthorized — the request lacks valid authentication credentials. Verify your Bearer token or API key is correct and has not expired.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}}}}}},"502Response":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","description":"Human-readable error description."}}}}}}}},"paths":{"/objects/{service}/{path_type}/{id}":{"get":{"operationId":"getObject","summary":"Get Object","description":"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.","tags":["Objects"],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/GetSubscriptionObjectResponse"},{"$ref":"#/components/schemas/GetCustomerObjectResponse"},{"$ref":"#/components/schemas/GetOrderObjectResponse"},{"$ref":"#/components/schemas/GetIdentityObjectResponse"},{"$ref":"#/components/schemas/CustomerAddress"},{"$ref":"#/components/schemas/GetScheduleObjectResponse"},{"$ref":"#/components/schemas/GetPaymentMethodObjectResponse"},{"$ref":"#/components/schemas/GetPromoCodeV2ObjectResponse"},{"$ref":"#/components/schemas/GetPromoCodeV3ObjectResponse"},{"$ref":"#/components/schemas/GetSubscriptionOfferObjectResponse"},{"$ref":"#/components/schemas/GetUserEntitlementObjectResponse"}]}}}},"401":{"$ref":"#/components/responses/401Response"},"502":{"$ref":"#/components/responses/502Response"}}}}}}
```

## Update Object

> 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.

```json
{"openapi":"3.1.0","info":{"title":"Limio Commerce API","version":"1.0.0"},"tags":[{"name":"Objects","description":"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."}],"servers":[{"url":"https://{tenant}/api","description":"Limio environment API","variables":{"tenant":{"default":"your-environment.prod.limio.com","description":"Your Limio environment hostname, e.g. `acme.prod.limio.com` or `acme-sandbox.prod.limio.com`."}}}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"OAuth 2.0 Bearer token for authenticated API access. Required for order submission, object management, and administrative operations.\n\nObtain a token via the OAuth flow described in [OAuth Bearer Token](https://docs.limio.com/developers/api-documentation/authentication-overview/oauth-bearer-token).\n\nPass the token in the `Authorization` header: `Bearer <token>`"}},"schemas":{"UpdateObject":{"type":"object","properties":{"name":{"type":"string","description":"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"},"data":{"type":"object","oneOf":[{"properties":{"quantity":{"type":"number"}}},{"$ref":"#/components/schemas/PromoCodeWholeBasket"},{"$ref":"#/components/schemas/PromoCodeSelectedItems"},{"$ref":"#/components/schemas/PromoCodeV3Data"}]}},"required":["data"]},"PromoCodeWholeBasket":{"type":"object","allOf":[{"properties":{"applicationLevel":{"type":"string","enum":["wholeBasket"],"description":"Specifies if the promo code applies to the whole basket."}}},{"$ref":"#/components/schemas/PromoCodeData"}],"required":["applicationLevel"]},"PromoCodeData":{"type":"object","properties":{"promoCode":{"type":"string","description":"The object 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"},"status":{"type":"boolean","description":"Sets the status of the promo code. If true, the promo code is active. If false, the promo code is inactive."},"description":{"type":"string","description":"A brief description of the promo code."},"promoStartDate":{"type":"string","format":"date","description":"The start date for the promo code. If no start date is provided, the promo code will be active immediately providing the status is set to active."},"promoExpiryDate":{"type":"string","format":"date","description":"The expiry date for the promo code. If no expiry date is provided, the promo code will be active indefinitely."},"productDetails":{"$ref":"#/components/schemas/PromoCodeProductDetails"},"usage":{"type":"object","properties":{"availableQuantity":{"type":"number","description":"The number of times the promo code can be used. If undefined, the promo code can be used an unlimited number of times."}}},"discount":{"type":"object","oneOf":[{"title":"Discount Type Percentage","properties":{"discountType":{"type":"string","const":"DiscountPercentage"},"percentageDiscount":{"type":"number","description":"The percentage discount. Can be specified to 2 decimal places. This should only be set if the discountType is DiscountPercentage."},"durationLength":{"type":"integer","description":"The duration length of the discount."},"durationType":{"type":"string","enum":["Days","Weeks","Months","Years"],"description":"The duration type (e.g., months)."}}},{"title":"Discount Type Fixed Amount","properties":{"discountType":{"type":"string","const":"DiscountFixedAmount"},"amountDiscount":{"type":"number","description":"The amount discount. Can be specified to 2 decimal places. This should only be set if the discountType is DiscountFixedAmount."},"currency":{"type":"string","description":"The currency of the discount. Remember to activate the associated currency of the rate plan in the billing system."},"durationLength":{"type":"integer","description":"The duration length of the discount."},"durationType":{"type":"string","enum":["Days","Weeks","Months","Years"],"description":"The duration type (e.g., months)."}}}]}},"required":["promoCode","status","productDetails","discount"]},"PromoCodeProductDetails":{"type":"object","properties":{"product":{"type":"object","properties":{"path":{"type":"string","description":"Path to the Limio Product."}}},"ratePlan":{"type":"object","properties":{"path":{"type":"string","description":"The name of the rate plan. This rate plan should exist in the product specified. Its type should match the discount type specified in the payload"}}}},"required":["product","ratePlan"]},"PromoCodeSelectedItems":{"type":"object","allOf":[{"properties":{"applicationLevel":{"type":"string","enum":["selectedItems"],"description":"Specifies if the promo code applies to selected items."},"referencedOfferLabel":{"type":"string","description":"A label referencing the specific offer. This corresponds to the label__limio value set in the offer or add-on"}}},{"$ref":"#/components/schemas/PromoCodeData"}],"required":["applicationLevel","referencedOfferLabel"]},"PromoCodeV3Data":{"type":"object","required":["promoCode","status"],"properties":{"promoCode":{"type":"string","description":"The promo code string that customers enter at checkout."},"status":{"type":"boolean","description":"Whether the promo code is active. When `true` the code can be redeemed; when `false` it is disabled."},"description":{"type":"string","description":"A brief description of the promo code."},"promoStartDate":{"type":"string","format":"date","description":"The date the promo code becomes redeemable (YYYY-MM-DD). If omitted the code is active immediately (when status is true)."},"promoExpiryDate":{"type":"string","format":"date","description":"The date the promo code expires (YYYY-MM-DD). If omitted the code does not expire."},"usage":{"type":"object","properties":{"availableQuantity":{"type":"integer","description":"Maximum number of times this code can be redeemed. If omitted the code has unlimited uses."},"redeemedQuantity":{"type":"integer","description":"Number of times the code has been redeemed so far."}}},"attachedDiscount":{"type":"object","description":"Reference to the discount catalog item that defines the pricing rules applied when this code is redeemed.","required":["id","path","name"],"properties":{"id":{"type":"string","description":"The Elasticsearch document ID of the discount."},"path":{"type":"string","description":"The catalog path of the discount."},"name":{"type":"string","description":"Display name of the discount."}}}}},"UpdateObjectResponse":{"type":"object","properties":{"id":{"type":"string","description":"The ID of the object"},"sort_key":{"type":"string","description":"The sort key of the object"},"data":{"type":"object","description":"The data of the object sent in the request"}}}},"responses":{"401Response":{"description":"Unauthorized — the request lacks valid authentication credentials. Verify your Bearer token or API key is correct and has not expired.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}}}}}}}},"paths":{"/objects/{service}/{path_type}/{id}":{"put":{"operationId":"updateObject","summary":"Update Object","description":"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.","tags":["Objects"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateObject"}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateObjectResponse"}}}},"400":{"description":"Bad request (missing required fields)"},"401":{"$ref":"#/components/responses/401Response"},"404":{"description":"Not found"}}}}}}
```

## Delete Object

> This API allows you to delete objects in Limio. Currently, only promo codes (v2 and v3) are deleted via this API.

```json
{"openapi":"3.1.0","info":{"title":"Limio Commerce API","version":"1.0.0"},"tags":[{"name":"Objects","description":"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."}],"servers":[{"url":"https://{tenant}/api","description":"Limio environment API","variables":{"tenant":{"default":"your-environment.prod.limio.com","description":"Your Limio environment hostname, e.g. `acme.prod.limio.com` or `acme-sandbox.prod.limio.com`."}}}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"OAuth 2.0 Bearer token for authenticated API access. Required for order submission, object management, and administrative operations.\n\nObtain a token via the OAuth flow described in [OAuth Bearer Token](https://docs.limio.com/developers/api-documentation/authentication-overview/oauth-bearer-token).\n\nPass the token in the `Authorization` header: `Bearer <token>`"}},"schemas":{"DeleteObjectResponse":{"type":"object","properties":{"httpStatusCode":{"type":"integer","description":"The HTTP status code of the response"},"requestId":{"type":"string","description":"The request ID"},"attempts":{"type":"integer","description":"The number of attempts made"},"totalRetryDelay":{"type":"integer","description":"The total retry delay in milliseconds"}}}},"responses":{"401Response":{"description":"Unauthorized — the request lacks valid authentication credentials. Verify your Bearer token or API key is correct and has not expired.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}}}}}},"502Response":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","description":"Human-readable error description."}}}}}}}},"paths":{"/objects/{service}/{path_type}/{id}":{"delete":{"operationId":"deleteObject","summary":"Delete Object","description":"This API allows you to delete objects in Limio. Currently, only promo codes (v2 and v3) are deleted via this API.","tags":["Objects"],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteObjectResponse"}}}},"401":{"$ref":"#/components/responses/401Response"},"404":{"description":"Not found"},"502":{"$ref":"#/components/responses/502Response"}}}}}}
```

## 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.

```json
{"openapi":"3.1.0","info":{"title":"Limio Commerce API","version":"1.0.0"},"tags":[{"name":"Objects","description":"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."}],"servers":[{"url":"https://{tenant}/api","description":"Limio environment API","variables":{"tenant":{"default":"your-environment.prod.limio.com","description":"Your Limio environment hostname, e.g. `acme.prod.limio.com` or `acme-sandbox.prod.limio.com`."}}}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"OAuth 2.0 Bearer token for authenticated API access. Required for order submission, object management, and administrative operations.\n\nObtain a token via the OAuth flow described in [OAuth Bearer Token](https://docs.limio.com/developers/api-documentation/authentication-overview/oauth-bearer-token).\n\nPass the token in the `Authorization` header: `Bearer <token>`"}},"parameters":{"service":{"in":"path","name":"service","required":true,"description":"The service the object belongs to","schema":{"type":"string","enum":["limio","zuora","salesforce"],"default":"limio"}},"path_type":{"in":"path","required":true,"name":"path_type","description":"The type of object to operate on. Determines the shape of the response data and which fields are available.","schema":{"type":"string","enum":["orders","customers","subscriptions","identities","address","schedules","payment_methods","subscription_offers","user_entitlements","gift_code","promo_codes_v2","promo_codes_v3","events","process"]}},"limit":{"in":"query","name":"limit","description":"Maximum number of objects to return. Defaults to 50 if not specified.","schema":{"type":"integer","default":50}},"queryMore":{"in":"query","name":"queryMore","description":"Retrieves the next page of results. Use the queryMore returned in the previous response.","schema":{"type":"string"}}},"schemas":{"GetOrderObjectsResponse":{"type":"object","description":"Get Order Objects Response object","title":"Get Orders Response","properties":{"items":{"type":"array","description":"Array of objects","items":{"$ref":"#/components/schemas/GetOrderObjectResponse"}}}},"GetOrderObjectResponse":{"type":"object","description":"Order object","title":"Get Order Response","properties":{"name":{"type":"string","description":"Order name"},"data":{"type":"object","description":"Order data","properties":{"email":{"type":"string"},"name":{"type":"string"},"tracking":{"$ref":"#/components/schemas/Tracking"},"country":{"type":"string"},"billingDetails":{"$ref":"#/components/schemas/BillingDetails"},"__spec_version":{"type":"string"},"external_id":{"type":"string"},"source":{"type":"string","enum":["salesforce","limio"]},"orderItems":{"type":"array","items":{"$ref":"#/components/schemas/OrderItem"}},"process_immediately":{"type":"boolean"},"mode":{"type":"string"},"total":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"integer"}}},"payment":{"type":"object","properties":{"type":{"type":"string"},"invoicePref":{"type":"string"}}},"customerDetails":{"type":"object","properties":{"lastName":{"type":"string"},"firstName":{"type":"string"}}},"sourceDetails":{"type":"object","properties":{"instance":{"type":"string"}}},"initiated_source":{"type":"string"},"orderDate":{"type":"string","format":"date-time"}}},"status":{"type":"string"},"record_type":{"type":"string"},"owner":{"type":"string"},"id":{"type":"string"},"service":{"type":"string"},"created":{"type":"string","format":"date-time"},"updated":{"type":"string","format":"date-time"},"reference":{"type":"string"},"mode":{"type":"string"},"authority":{"type":"object","properties":{"aut":{"type":"object","properties":{"iss":{"type":"string"},"sub":{"type":"string"}}},"permissions":{"type":"array","items":{"type":"string"}}}}}},"Tracking":{"type":"object","description":"Tracking data associated with the order, used for attribution and integration with external systems. When `accountId` is provided, the basket is assigned an owner and the response includes an `assistedCheckoutLink` for OBO (On-Behalf-Of) checkout flows.","properties":{"offers":{"type":"array","items":{"type":"string"}},"purchaseCountryCode":{"type":"string"},"accountId":{"type":"string","description":"Salesforce Account ID. When provided, Limio resolves or creates an identity owner for the basket and returns an `assistedCheckoutLink` in the response."},"contactId":{"type":"string","description":"Salesforce Contact ID associated with this order."},"userId":{"type":"string","description":"Salesforce User ID associated with this order."}}},"BillingDetails":{"type":"object","properties":{"country":{"type":"string"},"firstName":{"type":"string"},"lastName":{"type":"string"},"streetName":{"type":"string"},"city":{"type":"string"},"address1":{"type":"string"},"address2":{"type":"string"},"postalCode":{"type":"string"},"buildingNumber":{"type":"number"},"company":{"type":"string"},"state":{"type":"string"}}},"OrderItem":{"type":"object","properties":{"offer":{"$ref":"#/components/schemas/Offer"},"quantity":{"type":"integer"},"price":{"type":"object","properties":{"summary":{"type":"object","properties":{"headline":{"type":"string"}}},"currency":{"type":"string"},"amount":{"type":"integer"}}},"name":{"type":"string"},"id":{"type":"string"},"startDate":{"type":"string","format":"date"},"products":{"type":"array","items":{"$ref":"#/components/schemas/ProductDetails"}}}},"Offer":{"type":"object","description":"A Limio offer object representing a purchasable subscription offer with pricing, products, and configuration.","properties":{"mode":{"type":"string","description":"Deployment mode of the offer.","enum":["production","test"]},"path":{"type":"string","description":"Catalog path of the offer. V2 offers use `/offers2/...`, legacy offers use `/offers/...`."},"data":{"$ref":"#/components/schemas/OfferData"},"service":{"type":"string","description":"The service this offer belongs to."},"created":{"type":"string","format":"date-time","description":"Timestamp when the offer was created."},"name":{"type":"string","description":"Display name of the offer."},"id":{"type":"string","description":"Unique offer identifier (content-addressable hash)."},"type":{"type":"string","description":"Object type within the catalog hierarchy."},"updated":{"type":"string","format":"date-time","description":"Timestamp when the offer was last modified."},"version":{"type":"string","description":"Version hash of the offer. Changes when the offer content is updated. Used with the Published Offers API for versioned offer management."},"record_type":{"type":"string","description":"Object type identifier. Always `offer` for this schema."},"status":{"type":"string","description":"Publication status of the offer.","enum":["active","inactive"]}}},"OfferData":{"type":"object","properties":{"price__limio":{"type":"array","items":{}},"created":{"type":"string","format":"date-time"},"duplicatedFrom":{"type":"string"},"type":{"type":"string"},"version":{"type":"string"},"record_type":{"type":"string"},"productBundles":{"type":"array","items":{"type":"object","properties":{"revenue_split":{"type":"string"},"product_path":{"type":"string"},"rate_plan":{"type":"string"}}}},"products":{"type":"array","items":{"$ref":"#/components/schemas/ProductDetails"}},"baseTemplate":{"type":"string"},"path":{"type":"string"},"priceReference":{"type":"string"},"price":{"type":"array","items":{}},"name":{"type":"string"},"modified":{"type":"string","format":"date-time"},"attributes":{"type":"object","properties":{"checkout_description__limio":{"type":"string"},"price__limio":{"type":"array","items":{"type":"object","properties":{"delay_interval_type":{"type":"string"},"name":{"type":"string"},"delay_interval":{"type":"string"},"repeat_interval":{"type":"integer"},"attributes":{"type":"array","items":{}},"label":{"type":"string"},"trigger":{"type":"string"},"repeat_interval_type":{"type":"string"},"repeat_count":{"type":"integer"},"type":{"type":"string"},"value":{"type":"string"},"currencyCode":{"type":"string"}}}},"default_quantity_options__limio":{},"supportBillingFrequencyChange__zuora":{"type":"boolean"},"allowed_countries__limio":{"type":"array","items":{"type":"string"}},"label__limio":{"type":"array","items":{"type":"string"}},"term__limio":{"type":"object","properties":{"renewal_type":{"type":"string"},"renewal_trigger":{"type":"string"}}},"display_price__limio":{"type":"string"},"cta_text__limio":{"type":"string"},"payment_types__limio":{"type":"array","items":{"type":"string"}},"sales_channel__limio":{"type":"array","items":{"type":"string"}},"display_name__limio":{"type":"string"},"checkout__limio":{"type":"object","properties":{"checkout_type":{"type":"string"}}},"initial_term__limio":{"type":"object","properties":{"renewal_type":{"type":"string"},"length":{"type":"integer"},"renewal_trigger":{"type":"string"},"type":{"type":"string"}}},"push_to_checkout__limio":{"type":"boolean"},"autoRenew__limio":{"type":"boolean"},"offer_type__limio":{"type":"string"}}},"id":{"type":"string"},"user":{"type":"string"}}},"ProductDetails":{"type":"object","properties":{"baseTemplate":{"type":"string"},"entitlements":{"type":"array","items":{"$ref":"#/components/schemas/Entitlement"}},"path":{"type":"string"},"created":{"type":"string","format":"date-time"},"modified":{"type":"string","format":"date-time"},"attributes":{"$ref":"#/components/schemas/ProductAttributes"},"record_type":{"type":"string"},"lastSynced":{"type":"string","format":"date-time"},"synced":{"type":"boolean"},"syncedFrom":{"type":"string"}}},"Entitlement":{"type":"object","properties":{"$ref":{"type":"string"}}},"ProductAttributes":{"type":"object","properties":{"display_name__limio":{"type":"string"},"has_delivery__limio":{"type":"boolean"},"product_code__limio":{"type":"string"}}},"GetSubscriptionObjectsResponse":{"type":"object","description":"Response object","title":"Get Subscriptions Response","properties":{"items":{"type":"array","description":"Array of objects","items":{"$ref":"#/components/schemas/GetSubscriptionObjectResponse"}}}},"GetSubscriptionObjectResponse":{"type":"object","description":"Subscription object","title":"Get Subscription Response","properties":{"name":{"type":"string","description":"Subscription name"},"start":{"type":"string","format":"date","description":"Subscription start date"},"data":{"type":"object","description":"Subscription data","properties":{"name":{"type":"string","description":"Subscription data name"},"tracking":{"$ref":"#/components/schemas/Tracking"},"offer":{"type":"object","description":"Offer details","properties":{"mode":{"type":"string"},"path":{"type":"string"},"data":{"$ref":"#/components/schemas/OfferData"},"service":{"type":"string"},"created":{"type":"string","format":"date-time"},"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"updated":{"type":"string","format":"date-time"},"version":{"type":"string"},"record_type":{"type":"string"},"status":{"type":"string"}}},"quantity":{"type":"integer"},"termEndDate":{"type":"string","format":"date"},"price":{"type":"object","description":"Price details","properties":{"summary":{"type":"object","properties":{"headline":{"type":"string"}}},"currency":{"type":"string"},"amount":{"type":"number"}}},"termStartDate":{"type":"string","format":"date"},"attributes":{"type":"object","properties":{"gift":{"type":"boolean"},"external":{"type":"boolean"}}},"id":{"type":"string"},"purchaseCountry":{"type":"string"},"startDate":{"type":"string","format":"date"},"products":{"type":"array","items":{"$ref":"#/components/schemas/ProductDetails"}}}},"status":{"type":"string"},"record_type":{"type":"string"},"owner":{"type":"string"},"customer":{"type":"string"},"id":{"type":"string"},"service":{"type":"string"},"ref":{"type":"string"},"created":{"type":"string","format":"date-time"},"updated":{"type":"string","format":"date-time"},"reference":{"type":"string"},"mode":{"type":"string"}}},"GetCustomerObjectsResponse":{"type":"object","description":"Response object","title":"Get Customers Response","properties":{"items":{"type":"array","description":"Array of objects","items":{"$ref":"#/components/schemas/GetCustomerObjectResponse"}}}},"GetCustomerObjectResponse":{"type":"object","description":"Customer object","title":"Get Customer Response","properties":{"data":{"type":"object","description":"Customer data","properties":{"name":{"type":"string","description":"Full name of the customer"},"email":{"type":"string","format":"email","description":"Email address of the customer"},"firstName":{"type":"string","description":"First name of the customer"},"lastName":{"type":"string","description":"Last name of the customer"},"purchaseCountry":{"type":"string","description":"Country code of the customer's purchase"},"trialist":{"type":"boolean","description":"Indicates if the customer is a trialist"}}},"status":{"type":"string","description":"Status of the customer"},"record_type":{"type":"string","description":"Record type of the object"},"owner":{"type":"string","description":"ID of the owner of the customer"},"id":{"type":"string","description":"Unique identifier of the customer"},"service":{"type":"string","description":"Service associated with the customer"},"created":{"type":"string","format":"date-time","description":"Timestamp of when the customer was created"},"updated":{"type":"string","format":"date-time","description":"Timestamp of when the customer was last updated"},"reference":{"type":"string","description":"Reference code associated with the customer"},"mode":{"type":"string","description":"Mode of the customer object"}}},"GetIdentityObjectsResponse":{"type":"object","description":"Response object","title":"Get Identities Response","properties":{"items":{"type":"array","description":"Array of objects","items":{"$ref":"#/components/schemas/GetIdentityObjectResponse"}}}},"GetIdentityObjectResponse":{"type":"object","description":"Identity object","title":"Get Identity Response","properties":{"data":{"type":"object","description":"Identity data","properties":{"email":{"type":"string","format":"email"},"cognito:username":{"type":"string"},"email_verified":{"type":"boolean"},"event_id":{"type":"string"},"isValidated":{"type":"boolean"},"iss":{"type":"string"},"jti":{"type":"string"},"origin_jti":{"type":"string"},"sub":{"type":"string"}}},"status":{"type":"string"},"record_type":{"type":"string"},"record_variant":{"type":"string"},"owner":{"type":"string"},"id":{"type":"string"},"service":{"type":"string"},"created":{"type":"string","format":"date-time"},"updated":{"type":"string","format":"date-time"},"mode":{"type":"string"}}},"GetCustomerAddressObjectsResponse":{"type":"object","description":"Response object","title":"Get Customer Addresses Response","properties":{"items":{"type":"array","description":"Array of objects","items":{"$ref":"#/components/schemas/CustomerAddress"}}}},"CustomerAddress":{"type":"object","description":"Customer Address object","title":"Get Customer Address Response","properties":{"record_type":{"type":"string"},"id":{"type":"string"},"relationship_id":{"type":"string"},"data":{"type":"object","properties":{"firstName":{"type":"string"},"lastName":{"type":"string"},"country":{"type":"string"},"address2":{"type":"string"},"city":{"type":"string"},"address1":{"type":"string"},"postalCode":{"type":"string"},"company":{"type":"string"},"state":{"type":"string"},"email":{"type":"string","format":"email"}}},"related":{"type":"string"},"service":{"type":"string"},"start":{"type":"string","format":"date-time"},"relationship_type":{"type":"string"},"mode":{"type":"string"},"created":{"type":"string","format":"date-time"},"status":{"type":"string"},"owner":{"type":"string"},"customer":{"type":"string"},"updated":{"type":"string","format":"date-time"},"reference":{"type":"string"}}},"GetScheduleObjectsResponse":{"type":"object","description":"Response object","title":"Get Schedules Response","properties":{"items":{"type":"array","description":"Array of objects","items":{"$ref":"#/components/schemas/GetScheduleObjectResponse"}}}},"GetScheduleObjectResponse":{"type":"object","description":"Schedule object","title":"Get Schedule Response","properties":{"data":{"type":"object","description":"Schedule data","properties":{"date":{"type":"string","format":"date-time"},"amountWithoutTax":{"type":"string"},"lineItems":{"type":"array","items":{"type":"object","properties":{"amountWithoutTax":{"type":"string"},"processingType":{"type":"string"},"quantity":{"type":"integer"},"taxAmount":{"type":"string"},"chargeName":{"type":"string"},"productName":{"type":"string"},"chargeDescription":{"type":"string"}}}},"amount":{"type":"string"},"quantity":{"type":"integer"},"description":{"type":"string"},"currency":{"type":"string"},"unit_amount":{"type":"string"},"schedule_date":{"type":"string","format":"date-time"},"type":{"type":"string"},"taxAmount":{"type":"integer"}}},"status":{"type":"string"},"record_type":{"type":"string"},"related":{"type":"string"},"owner":{"type":"string"},"id":{"type":"string"},"service":{"type":"string"},"created":{"type":"string","format":"date-time"},"updated":{"type":"string","format":"date-time"},"reference":{"type":"string"},"mode":{"type":"string"}}},"GetPaymentMethodObjectsResponse":{"type":"object","description":"Response object","title":"Get Payment Methods Response","properties":{"items":{"type":"array","description":"Array of objects","items":{"$ref":"#/components/schemas/GetPaymentMethodObjectResponse"}}}},"GetPaymentMethodObjectResponse":{"type":"object","description":"Payment Method object","title":"Get Payment Method Response","properties":{"type":{"type":"string"},"data":{"type":"object","description":"Payment method data","properties":{"type":{"type":"string"},"zuora":{"type":"object","properties":{"result":{"type":"object","properties":{"LastTransactionDateTime":{"type":"string","format":"date-time"},"LastTransactionStatus":{"type":"string"},"NumConsecutiveFailures":{"type":"integer"},"UpdatedDate":{"type":"string","format":"date-time"},"UpdatedById":{"type":"string"},"CreditCardExpirationMonth":{"type":"integer"},"CreditCardExpirationYear":{"type":"integer"},"CreditCardType":{"type":"string"},"CreditCardHolderName":{"type":"string"},"PaymentMethodStatus":{"type":"string"},"Active":{"type":"boolean"},"Type":{"type":"string"},"CreatedById":{"type":"string"},"CreditCardMaskNumber":{"type":"string"},"CreatedDate":{"type":"string","format":"date-time"},"BankIdentificationNumber":{"type":"string"},"IsCompany":{"type":"boolean"},"TotalNumberOfErrorPayments":{"type":"integer"},"Id":{"type":"string"},"TotalNumberOfProcessedPayments":{"type":"integer"},"UseDefaultRetryRule":{"type":"boolean"}}},"signature":{"type":"string"},"success":{"type":"boolean"},"tenantId":{"type":"string"},"responseFrom":{"type":"string"},"refId":{"type":"string"},"paymentGateway":{"type":"string"},"token":{"type":"string"}}},"timing":{"type":"object","properties":{"delta":{"type":"integer"}}},"address":{"type":"object","properties":{"country":{"type":"string"},"firstName":{"type":"string"},"lastName":{"type":"string"},"streetName":{"type":"string"},"address2":{"type":"string"},"city":{"type":"string"},"address1":{"type":"string"},"postalCode":{"type":"string"},"buildingNumber":{"type":"string"},"company":{"type":"string"},"state":{"type":"string"}}}}},"status":{"type":"string"},"record_type":{"type":"string"},"related":{"type":"string"},"owner":{"type":"string"},"customer":{"type":"string"},"id":{"type":"string"},"service":{"type":"string"},"created":{"type":"string","format":"date-time"},"updated":{"type":"string","format":"date-time"},"reference":{"type":"string"},"mode":{"type":"string"}}},"GetPromoCodeV2ObjectsResponse":{"type":"object","title":"Get Promo Code V2 Objects Response","properties":{"items":{"type":"array","description":"Array of objects","items":{"$ref":"#/components/schemas/GetPromoCodeV2ObjectResponse"}}}},"GetPromoCodeV2ObjectResponse":{"type":"object","description":"Promo Code V2 object","title":"Get Promo Code V2 Response","properties":{"name":{"type":"string","description":"Promo code name"},"data":{"$ref":"#/components/schemas/PromoCodeData"},"status":{"type":"string"},"record_type":{"type":"string"},"id":{"type":"string"},"service":{"type":"string"},"created":{"type":"string","format":"date-time"},"updated":{"type":"string","format":"date-time"},"mode":{"type":"string"}}},"PromoCodeData":{"type":"object","properties":{"promoCode":{"type":"string","description":"The object 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"},"status":{"type":"boolean","description":"Sets the status of the promo code. If true, the promo code is active. If false, the promo code is inactive."},"description":{"type":"string","description":"A brief description of the promo code."},"promoStartDate":{"type":"string","format":"date","description":"The start date for the promo code. If no start date is provided, the promo code will be active immediately providing the status is set to active."},"promoExpiryDate":{"type":"string","format":"date","description":"The expiry date for the promo code. If no expiry date is provided, the promo code will be active indefinitely."},"productDetails":{"$ref":"#/components/schemas/PromoCodeProductDetails"},"usage":{"type":"object","properties":{"availableQuantity":{"type":"number","description":"The number of times the promo code can be used. If undefined, the promo code can be used an unlimited number of times."}}},"discount":{"type":"object","oneOf":[{"title":"Discount Type Percentage","properties":{"discountType":{"type":"string","const":"DiscountPercentage"},"percentageDiscount":{"type":"number","description":"The percentage discount. Can be specified to 2 decimal places. This should only be set if the discountType is DiscountPercentage."},"durationLength":{"type":"integer","description":"The duration length of the discount."},"durationType":{"type":"string","enum":["Days","Weeks","Months","Years"],"description":"The duration type (e.g., months)."}}},{"title":"Discount Type Fixed Amount","properties":{"discountType":{"type":"string","const":"DiscountFixedAmount"},"amountDiscount":{"type":"number","description":"The amount discount. Can be specified to 2 decimal places. This should only be set if the discountType is DiscountFixedAmount."},"currency":{"type":"string","description":"The currency of the discount. Remember to activate the associated currency of the rate plan in the billing system."},"durationLength":{"type":"integer","description":"The duration length of the discount."},"durationType":{"type":"string","enum":["Days","Weeks","Months","Years"],"description":"The duration type (e.g., months)."}}}]}},"required":["promoCode","status","productDetails","discount"]},"PromoCodeProductDetails":{"type":"object","properties":{"product":{"type":"object","properties":{"path":{"type":"string","description":"Path to the Limio Product."}}},"ratePlan":{"type":"object","properties":{"path":{"type":"string","description":"The name of the rate plan. This rate plan should exist in the product specified. Its type should match the discount type specified in the payload"}}}},"required":["product","ratePlan"]},"GetPromoCodeV3ObjectsResponse":{"type":"object","title":"Get Promo Code V3 Objects Response","properties":{"items":{"type":"array","description":"Array of promo code v3 objects","items":{"$ref":"#/components/schemas/GetPromoCodeV3ObjectResponse"}}}},"GetPromoCodeV3ObjectResponse":{"type":"object","description":"Promo Code V3 object","title":"Get Promo Code V3 Response","properties":{"name":{"type":"string","description":"Promo code name"},"data":{"$ref":"#/components/schemas/PromoCodeV3Data"},"status":{"type":"string"},"record_type":{"type":"string"},"id":{"type":"string"},"service":{"type":"string"},"created":{"type":"string","format":"date-time"},"updated":{"type":"string","format":"date-time"},"mode":{"type":"string"}}},"PromoCodeV3Data":{"type":"object","required":["promoCode","status"],"properties":{"promoCode":{"type":"string","description":"The promo code string that customers enter at checkout."},"status":{"type":"boolean","description":"Whether the promo code is active. When `true` the code can be redeemed; when `false` it is disabled."},"description":{"type":"string","description":"A brief description of the promo code."},"promoStartDate":{"type":"string","format":"date","description":"The date the promo code becomes redeemable (YYYY-MM-DD). If omitted the code is active immediately (when status is true)."},"promoExpiryDate":{"type":"string","format":"date","description":"The date the promo code expires (YYYY-MM-DD). If omitted the code does not expire."},"usage":{"type":"object","properties":{"availableQuantity":{"type":"integer","description":"Maximum number of times this code can be redeemed. If omitted the code has unlimited uses."},"redeemedQuantity":{"type":"integer","description":"Number of times the code has been redeemed so far."}}},"attachedDiscount":{"type":"object","description":"Reference to the discount catalog item that defines the pricing rules applied when this code is redeemed.","required":["id","path","name"],"properties":{"id":{"type":"string","description":"The Elasticsearch document ID of the discount."},"path":{"type":"string","description":"The catalog path of the discount."},"name":{"type":"string","description":"Display name of the discount."}}}}},"GetSubscriptionOfferObjectsResponse":{"type":"object","description":"Response object","title":"Get Subscription Offers Response","properties":{"items":{"type":"array","description":"Array of objects","items":{"$ref":"#/components/schemas/GetSubscriptionOfferObjectResponse"}}}},"GetSubscriptionOfferObjectResponse":{"type":"object","description":"Subscription Offer object","title":"Get Subscription Offer Response","properties":{"data":{"type":"object","description":"Subscription Offer data","properties":{"name":{"type":"string"},"start":{"type":"string","format":"date-time"},"price":{"type":"object","description":"Price details","properties":{"summary":{"type":"object"},"currency":{"type":"string"},"amount":{"type":"number"}}},"offer":{"$ref":"#/components/schemas/Offer"},"quantity":{"type":"integer"},"details":{"type":"string"},"id":{"type":"string"},"tracking":{"type":"object","properties":{"offers":{"type":"array","items":{"type":"string"}},"lmo_offer":{"type":"string"},"campaign":{"type":"string"},"tag":{"type":"string"}}},"products":{"type":"array","items":{"type":"object","properties":{"baseTemplate":{"type":"string"},"entitlements":{"type":"array","items":{"type":"object","properties":{"$ref":{"type":"string"}}}},"path":{"type":"string"},"created":{"type":"string","format":"date-time"},"modified":{"type":"string","format":"date-time"},"attributes":{"type":"object","properties":{"display_name__limio":{"type":"string"},"Product Family":{"type":"string"},"product_code__limio":{"type":"string"}}},"record_subtype":{"type":"null"},"record_type":{"type":"string"}}}}}},"status":{"type":"string"},"record_type":{"type":"string"},"related":{"type":"string"},"owner":{"type":"string"},"customer":{"type":"string"},"id":{"type":"string"},"service":{"type":"string"},"created":{"type":"string","format":"date-time"},"updated":{"type":"string","format":"date-time"},"reference":{"type":"string"},"mode":{"type":"string"}}},"GetUserEntitlementObjectsResponse":{"type":"object","description":"Response object","title":"Get User Entitlements Response","properties":{"items":{"type":"array","description":"Array of objects","items":{"$ref":"#/components/schemas/GetUserEntitlementObjectResponse"}}}},"GetUserEntitlementObjectResponse":{"type":"object","description":"Entitlement object","title":"Get User Entitlement Response","properties":{"from":{"type":"string"},"code":{"type":"string"},"type":{"type":"string"},"endDate":{"type":"string","format":"date"},"startDate":{"type":"string","format":"date-time"},"effectiveDate":{"type":"string","format":"date-time"}}},"GetEventObjectsResponse":{"type":"object","title":"Get Event Objects Response","properties":{"items":{"type":"array","description":"Array of objects","items":{"$ref":"#/components/schemas/GetEventObjectResponse"}}}},"GetEventObjectResponse":{"type":"object","title":"Order Event Response","properties":{"data":{"type":"object","description":"Metadata about the event","properties":{"hasError":{"type":"boolean","description":"Indicates whether the event contains an error"},"message":{"type":"string","description":"Human-readable description of the event"},"source":{"type":"string","description":"Source of the event, either shop or salesforce"},"type":{"type":"string","description":"Type of event"}}},"status":{"type":"string","description":"Current status of the event"},"record_type":{"type":"string","description":"Type of record"},"id":{"type":"string","description":"Unique identifier for the event"},"service":{"type":"string","description":"Name of the service generating the event"},"created":{"type":"string","format":"date-time","description":"ISO timestamp when the event was created"},"mode":{"type":"string","description":"Environment mode in which the event occurred"}}},"GetProcessEventObjectsResponse":{"type":"object","title":"Get Process Event Objects Response","properties":{"items":{"type":"array","description":"Array of objects","items":{"$ref":"#/components/schemas/GetProcessEventObjectResponse"}}}},"GetProcessEventObjectResponse":{"type":"object","description":"Process event object indicating plugin results","title":"Process Event Response","properties":{"data":{"type":"object","description":"Event metadata containing plugin error details","properties":{"criticalPluginErrors":{"type":"array","description":"List of critical plugin errors that occurred during processing","items":{"type":"object","properties":{"name":{"type":"string","description":"Name of the plugin where the error occurred"},"stack":{"type":"string","description":"Full stack trace of the error"},"message":{"type":"string","description":"Error message returned by the plugin"},"critical":{"type":"boolean","description":"Whether the error is considered critical"}}}}}},"status":{"type":"string","description":"Status of the processing event"},"record_type":{"type":"string","description":"Type of record"},"id":{"type":"string","description":"Unique identifier for the event"},"service":{"type":"string","description":"Name of the service generating the event"},"created":{"type":"string","format":"date-time","description":"Timestamp of when the event was created"},"mode":{"type":"string","description":"Deployment mode"}}}},"responses":{"401Response":{"description":"Unauthorized — the request lacks valid authentication credentials. Verify your Bearer token or API key is correct and has not expired.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}}}}}},"502Response":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","description":"Human-readable error description."}}}}}}}},"paths":{"/objects/{service}/{path_type}":{"get":{"operationId":"getObjects","summary":"Get Objects","description":"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.","parameters":[{"$ref":"#/components/parameters/service"},{"$ref":"#/components/parameters/path_type"},{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/queryMore"}],"tags":["Objects"],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/GetOrderObjectsResponse"},{"$ref":"#/components/schemas/GetSubscriptionObjectsResponse"},{"$ref":"#/components/schemas/GetCustomerObjectsResponse"},{"$ref":"#/components/schemas/GetIdentityObjectsResponse"},{"$ref":"#/components/schemas/GetCustomerAddressObjectsResponse"},{"$ref":"#/components/schemas/GetScheduleObjectsResponse"},{"$ref":"#/components/schemas/GetPaymentMethodObjectsResponse"},{"$ref":"#/components/schemas/GetPromoCodeV2ObjectsResponse"},{"$ref":"#/components/schemas/GetPromoCodeV3ObjectsResponse"},{"$ref":"#/components/schemas/GetSubscriptionOfferObjectsResponse"},{"$ref":"#/components/schemas/GetUserEntitlementObjectsResponse"},{"$ref":"#/components/schemas/GetEventObjectsResponse"},{"$ref":"#/components/schemas/GetProcessEventObjectsResponse"}],"properties":{"queryMore":{"type":"string","description":"A token to retrieve the next set of results. If there are no more results, this field will not be returned."}}}}}},"401":{"$ref":"#/components/responses/401Response"},"502":{"$ref":"#/components/responses/502Response"}}}}}}
```

## Get Object Relationships

> 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.

```json
{"openapi":"3.1.0","info":{"title":"Limio Commerce API","version":"1.0.0"},"tags":[{"name":"Objects","description":"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."}],"servers":[{"url":"https://{tenant}/api","description":"Limio environment API","variables":{"tenant":{"default":"your-environment.prod.limio.com","description":"Your Limio environment hostname, e.g. `acme.prod.limio.com` or `acme-sandbox.prod.limio.com`."}}}],"security":[{"bearerAuth":["checkout"]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"OAuth 2.0 Bearer token for authenticated API access. Required for order submission, object management, and administrative operations.\n\nObtain a token via the OAuth flow described in [OAuth Bearer Token](https://docs.limio.com/developers/api-documentation/authentication-overview/oauth-bearer-token).\n\nPass the token in the `Authorization` header: `Bearer <token>`"}},"parameters":{"service":{"in":"path","name":"service","required":true,"description":"The service the object belongs to","schema":{"type":"string","enum":["limio","zuora","salesforce"],"default":"limio"}},"path_type":{"in":"path","required":true,"name":"path_type","description":"The type of object to operate on. Determines the shape of the response data and which fields are available.","schema":{"type":"string","enum":["orders","customers","subscriptions","identities","address","schedules","payment_methods","subscription_offers","user_entitlements","gift_code","promo_codes_v2","promo_codes_v3","events","process"]}},"id":{"in":"path","name":"id","required":true,"description":"The unique identifier of the object. Format varies by object type (e.g. `sub-...` for subscriptions, `cus-...` for customers, `order-...` for orders).","schema":{"type":"string"}}},"schemas":{"RelatedObjectsResponse":{"type":"object","description":"Related Objects","properties":{"items":{"type":"array","items":{"type":"object","description":"Related Object","properties":{"name":{"type":"string","description":"Related Object name"},"id":{"type":"string","description":"Related Object id"},"relationship_id":{"type":"string","description":"Relationship id"},"type":{"type":"string","description":"Related Object type","enum":["zuora"]},"record_type":{"type":"string","description":"Related Object record type","enum":["customer","order","subscription_offer","address","event","identity","subscription","payment_method"]},"service":{"type":"string","description":"Related Object service","enum":["limio","zuora","salesforce","zephr"]},"mode":{"type":"string","description":"Mode in which the related object was created"},"created":{"type":"string","format":"date-time","description":"ISO date string on which the related object was created"},"data":{"type":"object","description":"Relationship data","properties":{"reference":{"type":"string","description":"Relationship reference"},"id":{"type":"string","description":"Object id"},"related":{"type":"string","description":"The id of the object to which this relationship object is related"},"record_type":{"type":"string","description":"Relationship record type"},"service":{"type":"string","description":"Relationship service"},"mode":{"type":"string","description":"Mode in which the relationship was created"},"created":{"type":"string","description":"ISO date string on which the relationship was created"},"data":{"type":"object","description":"Data of the two objects in the relationship","properties":{"from":{"type":"object","properties":{"name":{"type":"string","description":"Object name"},"id":{"type":"string","description":"Object id"},"record_type":{"type":"string","description":"Object record type"},"service":{"type":"string","description":"Object service"},"data":{"type":"object","description":"Additional object data"}}},"to":{"type":"object","properties":{"name":{"type":"string","description":"Object name"},"id":{"type":"string","description":"Object id"},"record_type":{"type":"string","description":"Object record type"},"service":{"type":"string","description":"Object service"},"data":{"type":"object","description":"Additional object data"}}},"metadata":{"type":"object","description":"Additional relationship data"}}}}}}}}}}},"responses":{"401Response":{"description":"Unauthorized — the request lacks valid authentication credentials. Verify your Bearer token or API key is correct and has not expired.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}}}}}},"502Response":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","description":"Human-readable error description."}}}}}}}},"paths":{"/objects/{service}/{path_type}/{id}/related":{"get":{"operationId":"getObjectRelationships","summary":"Get Object Relationships","tags":["Objects"],"description":"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.","parameters":[{"$ref":"#/components/parameters/service"},{"$ref":"#/components/parameters/path_type"},{"$ref":"#/components/parameters/id"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RelatedObjectsResponse"}}}},"401":{"$ref":"#/components/responses/401Response"},"502":{"$ref":"#/components/responses/502Response"}}}}}}
```

## 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.

```json
{"openapi":"3.1.0","info":{"title":"Limio Commerce API","version":"1.0.0"},"tags":[{"name":"Objects","description":"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."}],"servers":[{"url":"https://{tenant}/api","description":"Limio environment API","variables":{"tenant":{"default":"your-environment.prod.limio.com","description":"Your Limio environment hostname, e.g. `acme.prod.limio.com` or `acme-sandbox.prod.limio.com`."}}}],"security":[{"bearerAuth":["checkout"]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"OAuth 2.0 Bearer token for authenticated API access. Required for order submission, object management, and administrative operations.\n\nObtain a token via the OAuth flow described in [OAuth Bearer Token](https://docs.limio.com/developers/api-documentation/authentication-overview/oauth-bearer-token).\n\nPass the token in the `Authorization` header: `Bearer <token>`"}},"parameters":{"record_type":{"in":"path","name":"record_type","required":true,"description":"The record type of the object","schema":{"type":"string","enum":["offer","order","customer","gift_code","promo_code","promo_code_v3","identity","schedule","subscription_offer","payment_method","rate_plan","entitlement","product"]}}},"schemas":{"RelatedObjectsResponse":{"type":"object","description":"Related Objects","properties":{"items":{"type":"array","items":{"type":"object","description":"Related Object","properties":{"name":{"type":"string","description":"Related Object name"},"id":{"type":"string","description":"Related Object id"},"relationship_id":{"type":"string","description":"Relationship id"},"type":{"type":"string","description":"Related Object type","enum":["zuora"]},"record_type":{"type":"string","description":"Related Object record type","enum":["customer","order","subscription_offer","address","event","identity","subscription","payment_method"]},"service":{"type":"string","description":"Related Object service","enum":["limio","zuora","salesforce","zephr"]},"mode":{"type":"string","description":"Mode in which the related object was created"},"created":{"type":"string","format":"date-time","description":"ISO date string on which the related object was created"},"data":{"type":"object","description":"Relationship data","properties":{"reference":{"type":"string","description":"Relationship reference"},"id":{"type":"string","description":"Object id"},"related":{"type":"string","description":"The id of the object to which this relationship object is related"},"record_type":{"type":"string","description":"Relationship record type"},"service":{"type":"string","description":"Relationship service"},"mode":{"type":"string","description":"Mode in which the relationship was created"},"created":{"type":"string","description":"ISO date string on which the relationship was created"},"data":{"type":"object","description":"Data of the two objects in the relationship","properties":{"from":{"type":"object","properties":{"name":{"type":"string","description":"Object name"},"id":{"type":"string","description":"Object id"},"record_type":{"type":"string","description":"Object record type"},"service":{"type":"string","description":"Object service"},"data":{"type":"object","description":"Additional object data"}}},"to":{"type":"object","properties":{"name":{"type":"string","description":"Object name"},"id":{"type":"string","description":"Object id"},"record_type":{"type":"string","description":"Object record type"},"service":{"type":"string","description":"Object service"},"data":{"type":"object","description":"Additional object data"}}},"metadata":{"type":"object","description":"Additional relationship data"}}}}}}}}}}},"responses":{"401Response":{"description":"Unauthorized — the request lacks valid authentication credentials. Verify your Bearer token or API key is correct and has not expired.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}}}}}}}},"paths":{"/objects/{service}/{path_type}/{id}/related/{record_type}":{"get":{"operationId":"getObjectRelationshipsByRecordType","summary":"Get Object Relationships By Record Type","description":"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.","parameters":[{"$ref":"#/components/parameters/record_type"}],"tags":["Objects"],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RelatedObjectsResponse"}}}},"401":{"$ref":"#/components/responses/401Response"}}}}}}
```

## Add Object Relationship

> 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.

```json
{"openapi":"3.1.0","info":{"title":"Limio Commerce API","version":"1.0.0"},"tags":[{"name":"Objects","description":"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."}],"servers":[{"url":"https://{tenant}/api","description":"Limio environment API","variables":{"tenant":{"default":"your-environment.prod.limio.com","description":"Your Limio environment hostname, e.g. `acme.prod.limio.com` or `acme-sandbox.prod.limio.com`."}}}],"security":[{"bearerAuth":["checkout"]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"OAuth 2.0 Bearer token for authenticated API access. Required for order submission, object management, and administrative operations.\n\nObtain a token via the OAuth flow described in [OAuth Bearer Token](https://docs.limio.com/developers/api-documentation/authentication-overview/oauth-bearer-token).\n\nPass the token in the `Authorization` header: `Bearer <token>`"}},"responses":{"401Response":{"description":"Unauthorized — the request lacks valid authentication credentials. Verify your Bearer token or API key is correct and has not expired.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}}}}}},"502Response":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","description":"Human-readable error description."}}}}}}}},"paths":{"/objects/{service}/{path_type}/{id}/related/{record_type}":{"post":{"operationId":"addObjectRelationship","summary":"Add Object Relationship","description":"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.","tags":["Objects"],"parameters":[{"in":"path","name":"record_type","required":true,"description":"Only identity is allowed","schema":{"type":"string","default":"identity"}}],"requestBody":{"description":"Send order request","required":true,"content":{"application/json":{"schema":{"type":"object","description":"Related Object Request","properties":{"id":{"type":"string","description":"The identity to which you want to link the object to"},"service":{"type":"string","description":"The service of the identity","enum":["limio","zuora","salesforce"]}}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"null"}}}},"401":{"$ref":"#/components/responses/401Response"},"502":{"$ref":"#/components/responses/502Response"}}}}}}
```

## Get Child Objects

> 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.

```json
{"openapi":"3.1.0","info":{"title":"Limio Commerce API","version":"1.0.0"},"tags":[{"name":"Objects","description":"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."}],"servers":[{"url":"https://{tenant}/api","description":"Limio environment API","variables":{"tenant":{"default":"your-environment.prod.limio.com","description":"Your Limio environment hostname, e.g. `acme.prod.limio.com` or `acme-sandbox.prod.limio.com`."}}}],"security":[{"bearerAuth":["checkout"]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"OAuth 2.0 Bearer token for authenticated API access. Required for order submission, object management, and administrative operations.\n\nObtain a token via the OAuth flow described in [OAuth Bearer Token](https://docs.limio.com/developers/api-documentation/authentication-overview/oauth-bearer-token).\n\nPass the token in the `Authorization` header: `Bearer <token>`"}},"parameters":{"service":{"in":"path","name":"service","required":true,"description":"The service the object belongs to","schema":{"type":"string","enum":["limio","zuora","salesforce"],"default":"limio"}},"path_type":{"in":"path","required":true,"name":"path_type","description":"The type of object to operate on. Determines the shape of the response data and which fields are available.","schema":{"type":"string","enum":["orders","customers","subscriptions","identities","address","schedules","payment_methods","subscription_offers","user_entitlements","gift_code","promo_codes_v2","promo_codes_v3","events","process"]}},"id":{"in":"path","name":"id","required":true,"description":"The unique identifier of the object. Format varies by object type (e.g. `sub-...` for subscriptions, `cus-...` for customers, `order-...` for orders).","schema":{"type":"string"}}},"schemas":{"GetObjectSubTypeResponse":{"type":"object","description":"Children Objects","properties":{"items":{"type":"array","description":"Children Object array","items":{"type":"object","description":"Child Object","properties":{"name":{"type":"string","description":"Child Object name"},"id":{"type":"string","description":"Child Object id"},"related":{"type":"string","description":"The id of the object to which this child object is related"},"owner":{"type":"string","description":"The id of the parent object"},"record_type":{"type":"string","description":"Child Object record type"},"service":{"type":"string","description":"Child Object service"},"mode":{"type":"string","description":"Mode in which the child object was created"},"created":{"type":"string","description":"ISO date string on which the child object was created"},"data":{"type":"object","description":"Additional data of the child object"}}}}}}},"responses":{"401Response":{"description":"Unauthorized — the request lacks valid authentication credentials. Verify your Bearer token or API key is correct and has not expired.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}}}}}},"502Response":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","description":"Human-readable error description."}}}}}}}},"paths":{"/objects/{service}/{path_type}/{id}/objects":{"get":{"operationId":"getObjectSubType","summary":"Get Child Objects","tags":["Objects"],"description":"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.","parameters":[{"$ref":"#/components/parameters/service"},{"$ref":"#/components/parameters/path_type"},{"$ref":"#/components/parameters/id"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetObjectSubTypeResponse"}}}},"401":{"$ref":"#/components/responses/401Response"},"502":{"$ref":"#/components/responses/502Response"}}}}}}
```

## Get Child Objects by Record Type

> 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.

```json
{"openapi":"3.1.0","info":{"title":"Limio Commerce API","version":"1.0.0"},"tags":[{"name":"Objects","description":"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."}],"servers":[{"url":"https://{tenant}/api","description":"Limio environment API","variables":{"tenant":{"default":"your-environment.prod.limio.com","description":"Your Limio environment hostname, e.g. `acme.prod.limio.com` or `acme-sandbox.prod.limio.com`."}}}],"security":[{"bearerAuth":["checkout"]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"OAuth 2.0 Bearer token for authenticated API access. Required for order submission, object management, and administrative operations.\n\nObtain a token via the OAuth flow described in [OAuth Bearer Token](https://docs.limio.com/developers/api-documentation/authentication-overview/oauth-bearer-token).\n\nPass the token in the `Authorization` header: `Bearer <token>`"}},"parameters":{"service":{"in":"path","name":"service","required":true,"description":"The service the object belongs to","schema":{"type":"string","enum":["limio","zuora","salesforce"],"default":"limio"}},"path_type":{"in":"path","required":true,"name":"path_type","description":"The type of object to operate on. Determines the shape of the response data and which fields are available.","schema":{"type":"string","enum":["orders","customers","subscriptions","identities","address","schedules","payment_methods","subscription_offers","user_entitlements","gift_code","promo_codes_v2","promo_codes_v3","events","process"]}},"id":{"in":"path","name":"id","required":true,"description":"The unique identifier of the object. Format varies by object type (e.g. `sub-...` for subscriptions, `cus-...` for customers, `order-...` for orders).","schema":{"type":"string"}},"subtype":{"in":"path","name":"subtype","required":true,"description":"The record type of the child objects to retrieve.","schema":{"type":"string","enum":["offer","order","customer","gift_code","promo_code","promo_code_v3","identity","schedule","subscription_offer","payment_method","rate_plan","entitlement","product"]}}},"schemas":{"GetObjectSubTypeResponse":{"type":"object","description":"Children Objects","properties":{"items":{"type":"array","description":"Children Object array","items":{"type":"object","description":"Child Object","properties":{"name":{"type":"string","description":"Child Object name"},"id":{"type":"string","description":"Child Object id"},"related":{"type":"string","description":"The id of the object to which this child object is related"},"owner":{"type":"string","description":"The id of the parent object"},"record_type":{"type":"string","description":"Child Object record type"},"service":{"type":"string","description":"Child Object service"},"mode":{"type":"string","description":"Mode in which the child object was created"},"created":{"type":"string","description":"ISO date string on which the child object was created"},"data":{"type":"object","description":"Additional data of the child object"}}}}}}},"responses":{"401Response":{"description":"Unauthorized — the request lacks valid authentication credentials. Verify your Bearer token or API key is correct and has not expired.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}}}}}},"502Response":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","description":"Human-readable error description."}}}}}}}},"paths":{"/objects/{service}/{path_type}/{id}/objects/{subtype}":{"get":{"operationId":"getObjectSubTypeByRecordType","summary":"Get Child Objects by Record Type","tags":["Objects"],"description":"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.","parameters":[{"$ref":"#/components/parameters/service"},{"$ref":"#/components/parameters/path_type"},{"$ref":"#/components/parameters/id"},{"$ref":"#/components/parameters/subtype"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetObjectSubTypeResponse"}}}},"401":{"$ref":"#/components/responses/401Response"},"502":{"$ref":"#/components/responses/502Response"}}}}}}
```

## Get Object Events

> 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.

```json
{"openapi":"3.1.0","info":{"title":"Limio Commerce API","version":"1.0.0"},"tags":[{"name":"Objects","description":"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."}],"servers":[{"url":"https://{tenant}/api","description":"Limio environment API","variables":{"tenant":{"default":"your-environment.prod.limio.com","description":"Your Limio environment hostname, e.g. `acme.prod.limio.com` or `acme-sandbox.prod.limio.com`."}}}],"security":[{"bearerAuth":["checkout"]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"OAuth 2.0 Bearer token for authenticated API access. Required for order submission, object management, and administrative operations.\n\nObtain a token via the OAuth flow described in [OAuth Bearer Token](https://docs.limio.com/developers/api-documentation/authentication-overview/oauth-bearer-token).\n\nPass the token in the `Authorization` header: `Bearer <token>`"}},"parameters":{"service":{"in":"path","name":"service","required":true,"description":"The service the object belongs to","schema":{"type":"string","enum":["limio","zuora","salesforce"],"default":"limio"}},"path_type":{"in":"path","required":true,"name":"path_type","description":"The type of object to operate on. Determines the shape of the response data and which fields are available.","schema":{"type":"string","enum":["orders","customers","subscriptions","identities","address","schedules","payment_methods","subscription_offers","user_entitlements","gift_code","promo_codes_v2","promo_codes_v3","events","process"]}},"id":{"in":"path","name":"id","required":true,"description":"The unique identifier of the object. Format varies by object type (e.g. `sub-...` for subscriptions, `cus-...` for customers, `order-...` for orders).","schema":{"type":"string"}}},"schemas":{"GetObjectEventsResponse":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"record_type":{"type":"string"},"id":{"type":"string"},"relationship_id":{"type":"string"},"data":{"type":"object","properties":{"message":{"type":"string"},"type":{"type":"string"},"source":{"type":"string"}}},"related":{"type":"string"},"service":{"type":"string"},"mode":{"type":"string"},"created":{"type":"string","format":"date-time"},"status":{"type":"string"}}}},"unpackedItems":{"type":"array","items":{"type":"object","properties":{"mode":{"type":"string"},"status":{"type":"string"},"created":{"type":"string","format":"date-time"},"sort_key":{"type":"string"},"related":{"type":"string"},"reference":{"type":"string"},"service":{"type":"string"},"hash":{"type":"string"},"updated":{"type":"string","format":"date-time"},"header":{"type":"object","properties":{"from":{"type":"object","properties":{"id":{"type":"string"},"data":{"type":"object","properties":{"message":{"type":"string"},"type":{"type":"string"},"source":{"type":"string"}}},"record_type":{"type":"string"},"service":{"type":"string"},"status":{"type":"string"}}},"metadata":{"type":"object"},"to":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"data":{"type":"object"},"record_type":{"type":"string"},"service":{"type":"string"},"status":{"type":"string"}}}}},"tenant_id":{"type":"string"},"processName":{"type":"string"},"id":{"type":"string"},"record_type":{"type":"string"},"body":{"type":"object"}}}}}}},"responses":{"401Response":{"description":"Unauthorized — the request lacks valid authentication credentials. Verify your Bearer token or API key is correct and has not expired.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}}}}}},"502Response":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","description":"Human-readable error description."}}}}}}}},"paths":{"/objects/{service}/{path_type}/{id}/events":{"get":{"operationId":"getObjectEvents","summary":"Get Object Events","tags":["Objects"],"description":"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.","parameters":[{"$ref":"#/components/parameters/service"},{"$ref":"#/components/parameters/path_type"},{"$ref":"#/components/parameters/id"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetObjectEventsResponse"}}}},"401":{"$ref":"#/components/responses/401Response"},"502":{"$ref":"#/components/responses/502Response"}}}}}}
```