Limio
WebsiteHelp Desk
  • Home
  • Custom Components
    • Getting Started with Custom Components
    • Connecting External CI
    • Development Guidelines
    • Prop Types
    • Custom subcomponents
    • Connecting to External Service
  • Limio SDK
    • Getting Started with Limio SDK
    • Basket (Cart), Promo Code
    • Page, Offer, and Add-On
    • User, Subscription, Invoice & Address
    • Advanced Methods
      • Express Checkout
      • Core Utilities and Helpers
  • API Docs
    • Authentication Schemes
      • OAuth Bearer Token
      • API Key (Catalog API-only)
    • Catalog API
    • Promo Codes API
    • Order API
    • Objects API
    • Shop Build & Publish API
    • External Identities API
  • Webhooks
    • Using Webhooks
    • Webhooks Overview
  • I want to...
    • Retrieve abandoned baskets
    • Enable self-service on a CPQ order
Powered by GitBook
On this page

Was this helpful?

  1. API Docs

Objects API

Access and manage key subscription commerce objects through a unified REST API.

PreviousOrder APINextShop Build & Publish API

Last updated 7 days ago

Was this helpful?

This API enables you to retrieve and manage the following objects:

  • orders

  • customers

  • subscriptions

  • identities

  • address

  • schedules

  • payment_methods

  • subscription_offers

  • user_entitlements

  • gift_code

  • promo_codes_v2

Full documentation on how to use our Objects REST API can be found .

Sample API methods are available below:

here

Get Object

get

These APIs allow you to retrieve specific objects in Limio. You can get a subscription, customer, order, identity, address, schedule, payment method, subscription offer, user entitlement, event or process event object. You can also get a list of objects of a specific type using the Get Objects API.

Authorizations
Path parameters
servicestring · enumRequired

The service the object belongs to

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

Get Objects

get

These APIs allow you to retrieve a list of objects of a specific type in Limio. You can get a subscription, customer, order, identity, address, schedule, payment method, subscription offer, user entitlement, event or process event objects. Each object is returned with a summary of its data. To fetch all of the object data, use the retrieved object ID with the Get Object API.

Authorizations
Path parameters
servicestring · enumRequired

The service the object belongs to

Default: limioPossible values:
path_typestring · enumRequiredPossible values:
Query parameters
limitnumberOptional

The number of objects to return.

Example: 10
queryMorestringOptional

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

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

Delete Object

delete

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

Authorizations
Path parameters
servicestring · enumRequired

The service the object belongs to

Default: limioPossible values:
path_typestring · enumRequiredPossible values:
idstringRequiredExample: sub-abcxyz123456
Responses
200
OK
application/json
401
Unauthorized
application/json
404
Not found
502
Bad Gateway
application/json
delete
DELETE /api/objects/{service}/{path_type}/{id} HTTP/1.1
Host: your-environment.prod.limio.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
  "httpStatusCode": 200,
  "requestId": "1234ABC",
  "attempts": 1,
  "totalRetryDelay": 0
}

Get Object Relationships

get

This API allows you to get objects related to a specific object in Limio. You can get related objects of a subscription, customer, order, identity, address, schedule, payment method, subscription offer, or user entitlement.

Authorizations
Path parameters
servicestring · enumRequired

The service the object belongs to

Default: limioPossible values:
path_typestring · enumRequiredPossible values:
idstringRequiredExample: sub-abcxyz123456
Responses
200
OK
application/json
401
Unauthorized
application/json
502
Bad Gateway
application/json
get
GET /api/objects/{service}/{path_type}/{id}/related HTTP/1.1
Host: your-environment.prod.limio.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
  "items": [
    {
      "name": "Limio Subscription",
      "id": "e3535c52-3058-472e-aa4f-fe772a7c0f38",
      "relationship_id": "rel-123123sasdas",
      "type": "zuora",
      "record_type": "subscription",
      "service": "limio",
      "mode": "production",
      "created": "2020-03-18T16:02:01.526Z",
      "data": {
        "reference": "217OU0391HEG",
        "id": "e3535c52-3058-472e-aa4f-fe772a7c0f38",
        "related": "order-bcc1997b17b7824caf86b06451904fb8",
        "record_type": "rel",
        "service": "limio",
        "mode": "production",
        "created": "2020-03-18T16:02:01.526Z",
        "data": {
          "from": {
            "name": "Limio Subscription",
            "id": "e3535c52-3058-472e-aa4f-fe772a7c0f38",
            "record_type": "subscription",
            "service": "limio",
            "data": {}
          },
          "to": {
            "name": "Limio Order",
            "id": "order-bcc1997b17b7824caf86b06451904fb8",
            "record_type": "order",
            "service": "limio",
            "data": {}
          },
          "metadata": {}
        }
      }
    }
  ]
}
  • GETGet Object
  • GETGet Objects
  • PUTUpdate Object
  • DELETEDelete Object
  • GETGet Object Relationships

Update Object

put

This API allows you to update objects in Limio. You can update a subscription, customer, order, identity, address, schedule, payment method, subscription offer, promo code, or user entitlement. It is designed to be flexible and allow you to update any field in the object.

Authorizations
Path parameters
servicestring · enumRequired

The service the object belongs to

Default: limioPossible values:
path_typestring · enumRequiredPossible values:
idstringRequiredExample: sub-abcxyz123456
Body
namestringOptional

The object name such as the subscription name, or gift code name. Not included values will not be updated and nested values will require the structure to update. Updates will only occur for the id provided. WARNING! Changing this field might break integrations

Example: abc123
dataone ofRequired
or
all ofOptional
and
or
all ofOptional
and
Responses
200
OK
application/json
400
Bad request (missing required fields)
401
Unauthorized
application/json
404
Not found
put
PUT /api/objects/{service}/{path_type}/{id} HTTP/1.1
Host: your-environment.prod.limio.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 39

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