Partner Objects

Partner endpoints for accessing objects, customers, and invoices scoped to the authenticated partner organisation.

Search Partner Customers

get

Search for customers within the partner organisation context. Returns a paginated list of customer records matching the optional filter.

Required scopes

This endpoint requires the following scopes:

Authorizations

AuthorizationstringRequired

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

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

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

Query parameters

filterstringOptional

Search filter string (matches against customer name, email, etc.).

queryMorestringOptional

Pagination token from a previous response.

limitintegerOptional

Maximum number of results to return.

Default: 40

Responses

200

Customer search results.

application/json

itemsobject[]Optional

Matching customer records.

hitsintegerOptional

Total number of matching records.

queryMorestringOptional

Pagination token for the next page of results.

401

Unauthorized: the request lacks valid authentication credentials. Verify your Bearer token or API key is correct and has not expired.

application/json

502

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

application/json

get/partner/customer

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

{
  "items": [
    {}
  ],
  "hits": 1,
  "queryMore": "text"
}

List Partner Invoices

get

Retrieve invoices for the authenticated partner organisation from the billing provider (Zuora). Returns a paginated list of invoice records.

Required scopes

This endpoint requires the following scopes:

Authorizations

AuthorizationstringRequired

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

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

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

Query parameters

pageSizeinteger · min: 1 · max: 100Optional

Number of invoices per page.

Default: 40

cursorstringOptional

Pagination cursor from a previous response.

Responses

200

List of invoices.

application/json

invoicesobject[]Optional

Invoice records.

nextPagestringOptional

Cursor for the next page of results.

401

Unauthorized: the request lacks valid authentication credentials. Verify your Bearer token or API key is correct and has not expired.

application/json

502

application/json

get/partner/invoices

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

{
  "invoices": [
    {}
  ],
  "nextPage": "text"
}

Download Partner Invoice PDF

get

Download an invoice PDF file for the authenticated partner organisation. Returns the invoice as a base64-encoded PDF document.

Required scopes

This endpoint requires the following scopes:

Authorizations

AuthorizationstringRequired

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

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

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

Path parameters

idstringRequired

The invoice ID.

Responses

200

Invoice PDF file.

application/pdf

string · binaryOptional

401

Unauthorized: the request lacks valid authentication credentials. Verify your Bearer token or API key is correct and has not expired.

application/json

500

Returned when the invoice does not exist, has no PDF file, or does not belong to the authenticated partner organisation. The response body is generic and does not identify the cause.

application/json

502

application/json

get/partner/invoices/file/{id}

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

binary

Get Objects for Partner

get

Retrieve a paginated list of objects scoped to the authenticated partner organisation. Currently supports subscription as the object type. Each object includes a summary of its data. Use the queryMore token from the response to fetch subsequent pages.

Authorizations

AuthorizationstringRequired

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

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

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

Path parameters

path_typestring · enumRequired

The type of object to retrieve. Currently only subscription is supported.

Example: subscriptionPossible values:

Query parameters

limitintegerOptional

Maximum number of records to return.

Default: 40Example: 20

queryMorestringOptional

Pagination token from a previous response. Pass this to retrieve the next page of results.

Example: eyJjcmVhdGVkIjoiMjAyNC0wMy0wMVQwMTozNjowOC4zMjVaIn0=

Responses

200

application/json

401

Unauthorized: the request lacks valid authentication credentials. Verify your Bearer token or API key is correct and has not expired.

application/json

502

application/json

get/partner/objects/{path_type}

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

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

PreviousPartner Orders NextModels

Last updated 5 days ago

Was this helpful?