Get Objects For Partner

APIs to fetch objects for partner organisations

Get Objects For Partner

get

Retrieve a list of objects of the specified type associated with your partner organisation. Each object is returned with a summary of its data.

Authorizations

bearerAuth

AuthorizationstringRequired

To create a Bearer token, see How to get an OAuth Bearer Token?.

Usage format: Bearer <token>

Path parameters

path_typestring · enumRequired

The type of object to retrieve

Example: subscriptionPossible values:

Query parameters

limitintegerOptional

The maximum number of records to return

Example: 20

queryMorestringOptional

A token to retrieve the next set of results. The token can be retrieved from the queryMore field in the response of a previous call to this endpoint. If there are no more results, this field will not be returned.

Example: eyJjcmVhdGVkIjoiMjAyNC0wMy0wMVQwMTozNjowOC4zMjVaIn0=

Responses

200

OK

application/json

401

Unauthorized

application/json

502

Bad Gateway

application/json

get

/partner/objects/{path_type}

HTTPcURLJavaScriptPython

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

{
  "queryMore": "eyJjcmVhdGVkIjoiMjAyNC0wMy0wMVQwMTozNjowOCC4zMjVaIn0=",
  "items": [
    {
      "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": "[email protected]"
          },
          "service": "limio",
          "created": "2024-03-12T17:30:40.337Z",
          "name": "$75 for 52 weeks then $31.96 every 4 weeks autorenew",
          "id": "998f6ca141d60006e1e239b9f4b4e725bf1615d3",
          "type": "item",
          "updated": "2024-03-12T17:30:40.337Z",
          "version": "121defc69da9962e4b78424234577aa7717f4daf",
          "record_type": "offer",
          "status": "active"
        },
        "quantity": 1,
        "termEndDate": "2025-03-21",
        "price": {
          "summary": {
            "headline": "<p>Display Price</p>"
          },
          "currency": "USD",
          "amount": 75
        },
        "termStartDate": "2024-03-22",
        "attributes": {
          "gift": false,
          "external": false
        },
        "id": "bdc3cfb7-77b9-d8b8-7395-f44758ef1b29",
        "purchaseCountry": "GB",
        "startDate": "2024-03-22",
        "products": [
          {
            "baseTemplate": "/config/templates/products/default",
            "entitlements": [
              {
                "$ref": "/entitlements/Digital"
              }
            ],
            "path": "/products/Digital",
            "created": "2023-12-11T13:44:43+00:00",
            "modified": "2024-01-15T13:56:18+00:00",
            "attributes": {
              "display_name__limio": "Digital",
              "has_delivery__limio": false,
              "product_code__limio": "LI.DIGITAL"
            },
            "record_type": "product",
            "lastSynced": "2024-03-12T16:00:35.232Z",
            "synced": true,
            "syncedFrom": "2c92c0f9778c090d0177aa4f357d043b"
          }
        ]
      },
      "status": "initial",
      "record_type": "subscription",
      "owner": "id-39e4c3727b273ec4110b5769c10cdb52",
      "customer": "cus-81f7a36b4737e4d07b56e89d392a4d6e",
      "id": "sub-7f0146cba78f9455e57875402643f103",
      "service": "limio",
      "ref": "order-db546637c354a63b0eeaa121a0c14f0b/bdc3cfb7-77b9-d8b8-7395-f44758ef1b29",
      "created": "2024-03-22T12:13:29.718Z",
      "updated": "2024-03-22T12:13:29.718Z",
      "reference": "3V053CN9SFIG",
      "mode": "production"
    }
  ]
}