# Partner Objects

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

## Search Partner Customers

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

```json
{"openapi":"3.1.0","info":{"title":"Limio Commerce API","version":"1.0.0"},"tags":[{"name":"Partner Objects","description":"Partner endpoints for accessing objects, customers, and invoices scoped to the authenticated partner organisation."}],"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":["partner"]}],"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":{"/partner/customer":{"get":{"operationId":"searchPartnerCustomers","summary":"Search Partner Customers","tags":["Partner Objects"],"description":"Search for customers within the partner organisation context. Returns a paginated list of customer records matching the optional filter.","parameters":[{"name":"filter","in":"query","required":false,"description":"Search filter string (matches against customer name, email, etc.).","schema":{"type":"string"}},{"name":"queryMore","in":"query","required":false,"description":"Pagination token from a previous response.","schema":{"type":"string"}},{"name":"limit","in":"query","required":false,"description":"Maximum number of results to return.","schema":{"type":"integer","default":40}}],"responses":{"200":{"description":"Customer search results.","content":{"application/json":{"schema":{"type":"object","properties":{"items":{"type":"array","description":"Matching customer records.","items":{"type":"object"}},"hits":{"type":"integer","description":"Total number of matching records."},"queryMore":{"type":"string","description":"Pagination token for the next page of results."}}}}}},"401":{"$ref":"#/components/responses/401Response"},"502":{"$ref":"#/components/responses/502Response"}}}}}}
```

## List Partner Invoices

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

```json
{"openapi":"3.1.0","info":{"title":"Limio Commerce API","version":"1.0.0"},"tags":[{"name":"Partner Objects","description":"Partner endpoints for accessing objects, customers, and invoices scoped to the authenticated partner organisation."}],"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":["partner"]}],"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":{"/partner/invoices":{"get":{"operationId":"getPartnerInvoices","summary":"List Partner Invoices","tags":["Partner Objects"],"description":"Retrieve invoices for the authenticated partner organisation from the billing provider (Zuora). Returns a paginated list of invoice records.","parameters":[{"name":"pageSize","in":"query","required":false,"description":"Number of invoices per page.","schema":{"type":"integer","minimum":1,"maximum":100,"default":40}},{"name":"cursor","in":"query","required":false,"description":"Pagination cursor from a previous response.","schema":{"type":"string"}}],"responses":{"200":{"description":"List of invoices.","content":{"application/json":{"schema":{"type":"object","properties":{"invoices":{"type":"array","description":"Invoice records.","items":{"type":"object"}},"nextPage":{"type":"string","description":"Cursor for the next page of results."}}}}}},"401":{"$ref":"#/components/responses/401Response"},"502":{"$ref":"#/components/responses/502Response"}}}}}}
```

## Download Partner Invoice PDF

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

```json
{"openapi":"3.1.0","info":{"title":"Limio Commerce API","version":"1.0.0"},"tags":[{"name":"Partner Objects","description":"Partner endpoints for accessing objects, customers, and invoices scoped to the authenticated partner organisation."}],"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":["partner"]}],"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":{"/partner/invoices/file/{id}":{"get":{"operationId":"getPartnerInvoiceFile","summary":"Download Partner Invoice PDF","tags":["Partner Objects"],"description":"Download an invoice PDF file for the authenticated partner organisation. Returns the invoice as a base64-encoded PDF document.","parameters":[{"name":"id","in":"path","required":true,"description":"The invoice ID.","schema":{"type":"string"}}],"responses":{"200":{"description":"Invoice PDF file.","content":{"application/pdf":{"schema":{"type":"string","format":"binary"}}}},"401":{"$ref":"#/components/responses/401Response"},"404":{"description":"Invoice not found."},"502":{"$ref":"#/components/responses/502Response"}}}}}}
```

## Get Objects for Partner

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

```json
{"openapi":"3.1.0","info":{"title":"Limio Commerce API","version":"1.0.0"},"tags":[{"name":"Partner Objects","description":"Partner endpoints for accessing objects, customers, and invoices scoped to the authenticated partner organisation."}],"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":{"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"}}},"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"}}}},"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":{"/partner/objects/{path_type}":{"get":{"operationId":"getObjectsForPartner","summary":"Get Objects for Partner","tags":["Partner Objects"],"description":"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.","parameters":[{"name":"path_type","in":"path","required":true,"description":"The type of object to retrieve. Currently only `subscription` is supported.","schema":{"type":"string","enum":["subscription"]}},{"name":"limit","in":"query","required":false,"description":"Maximum number of records to return.","schema":{"type":"integer","default":50}},{"name":"queryMore","in":"query","required":false,"description":"Pagination token from a previous response. Pass this to retrieve the next page of results.","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/GetSubscriptionObjectsResponse"}],"properties":{"queryMore":{"type":"string","description":"Token to retrieve the next page. Absent when no more results."}}}}}},"401":{"$ref":"#/components/responses/401Response"},"502":{"$ref":"#/components/responses/502Response"}}}}}}
```