Partner Management

Manage partner organisations and their users. Create, update, and delete partner organisations, and manage user access within them.

List Partner Organisations

get

Retrieve a paginated list of all partner organisations. Each organisation includes its name, associated Zuora/Salesforce account IDs, and configuration. 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>

Query parameters

limitintegerOptional

Maximum number of partner organisations to return.

Example: 20

Responses

200

application/json

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

get/partner-management/partner-organisations

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

{
  "items": [
    {
      "id": "text",
      "name": "text",
      "data": {
        "zuoraAccountId": "text",
        "zuoraInvoiceOwner": "partner",
        "salesforceAccountId": "text",
        "logo": "https://example.com"
      },
      "record_type": "partner_org",
      "service": "limio",
      "created": "2026-01-01T00:00:00.000Z",
      "modified": "2026-01-01T00:00:00.000Z"
    }
  ],
  "queryMore": "text"
}

Create Partner Organisation

post

Create a new partner organisation. A partner organisation represents an external entity (e.g. reseller, affiliate) that can submit orders and manage subscriptions on behalf of end customers. Requires at minimum a name and Zuora account linkage.

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>

Body

namestringRequired

Display name of the partner organisation.

Example: Acme Resellers

zuoraAccountIdstringRequired

Zuora account ID to link to this partner.

Example: 2c92c0f978...

zuoraInvoiceOwnerstring · enumRequired

Who owns invoices in Zuora for this partner's subscriptions: the partner organisation itself (partner) or the end customer (end_customer).

Example: partnerPossible values:

salesforceAccountIdstringOptional

Optional Salesforce account ID for CRM integration.

Example: 001Dn00000...

logostring · uriOptional

URL to the partner organisation's logo.

Example: https://example.com/logo.png

Responses

200

Partner organisation created successfully.

application/json

idstringOptional

Unique identifier for the partner organisation

namestringOptional

Organisation name

record_typestring · enumOptionalPossible values:

servicestringOptionalExample: limio

createdstring · date-timeOptional

modifiedstring · date-timeOptional

401

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

application/json

post/partner-management/partner-organisation

POST /api/partner-management/partner-organisation HTTP/1.1
Host: your-environment.prod.limio.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 164

{
  "name": "Acme Resellers",
  "zuoraAccountId": "2c92c0f978...",
  "zuoraInvoiceOwner": "partner",
  "salesforceAccountId": "001Dn00000...",
  "logo": "https://example.com/logo.png"
}

{
  "id": "text",
  "name": "text",
  "data": {
    "zuoraAccountId": "text",
    "zuoraInvoiceOwner": "partner",
    "salesforceAccountId": "text",
    "logo": "https://example.com"
  },
  "record_type": "partner_org",
  "service": "limio",
  "created": "2026-01-01T00:00:00.000Z",
  "modified": "2026-01-01T00:00:00.000Z"
}

Create Partner User

post

Create a new user for a specific partner organisation

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

partnerOrganisationIdstringRequired

Partner organisation ID

Body

emailstring · emailRequired

User email address

namestringOptional

Display name for the user

Responses

200

Created

application/json

idstringOptional

Unique identifier for the partner user

namestringOptional

User identifier (typically email)

partner_orgstringOptional

Associated partner organisation ID

record_typestring · enumOptionalPossible values:

servicestringOptionalExample: limio

createdstring · date-timeOptional

modifiedstring · date-timeOptional

401

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

application/json

409

A user with this email address already exists

application/json

post/partner-management/partner-organisation/{partnerOrganisationId}

POST /api/partner-management/partner-organisation/{partnerOrganisationId} HTTP/1.1
Host: your-environment.prod.limio.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 40

{
  "email": "name@gmail.com",
  "name": "text"
}

{
  "id": "text",
  "name": "text",
  "data": {
    "email": "name@gmail.com"
  },
  "partner_org": "text",
  "record_type": "partner_user",
  "service": "limio",
  "created": "2026-01-01T00:00:00.000Z",
  "modified": "2026-01-01T00:00:00.000Z"
}

Update Partner Organisation

put

Update an existing partner organisation's details

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

partnerOrganisationIdstringRequired

Partner organisation ID

Body

namestringOptional

New display name for the organisation

zuoraAccountIdstringOptional

Associated Zuora account ID

zuoraInvoiceOwnerstring · enumOptional

Who owns invoices in Zuora for this partner's subscriptions: the partner organisation itself (partner) or the end customer (end_customer)

Possible values:

salesforceAccountIdstringOptional

Associated Salesforce account ID

logostring · uriOptional

Organisation logo URL

Responses

200

Updated

application/json

idstringOptional

Unique identifier for the partner organisation

namestringOptional

Organisation name

record_typestring · enumOptionalPossible values:

servicestringOptionalExample: limio

createdstring · date-timeOptional

modifiedstring · date-timeOptional

401

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

application/json

put/partner-management/partner-organisation/{partnerOrganisationId}

PUT /api/partner-management/partner-organisation/{partnerOrganisationId} HTTP/1.1
Host: your-environment.prod.limio.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 127

{
  "name": "text",
  "zuoraAccountId": "text",
  "zuoraInvoiceOwner": "partner",
  "salesforceAccountId": "text",
  "logo": "https://example.com"
}

{
  "id": "text",
  "name": "text",
  "data": {
    "zuoraAccountId": "text",
    "zuoraInvoiceOwner": "partner",
    "salesforceAccountId": "text",
    "logo": "https://example.com"
  },
  "record_type": "partner_org",
  "service": "limio",
  "created": "2026-01-01T00:00:00.000Z",
  "modified": "2026-01-01T00:00:00.000Z"
}

Delete Partner Organisation

delete

Delete a partner organisation and all associated users

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

partnerOrganisationIdstringRequired

Partner organisation ID

Responses

200

Deleted

application/json

successbooleanOptionalExample: true

401

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

application/json

delete/partner-management/partner-organisation/{partnerOrganisationId}

DELETE /api/partner-management/partner-organisation/{partnerOrganisationId} HTTP/1.1
Host: your-environment.prod.limio.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "success": true
}

List Partner Users for Organisation

get

Retrieve all users associated with a specific partner organisation

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

partnerOrganisationIdstringRequired

Partner organisation ID

Query parameters

limitintegerOptional

Maximum number of partner users to return

Example: 20

Responses

200

application/json

queryMorestringOptional

Token for 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

get/partner-management/partner-organisation/{partnerOrganisationId}/users

GET /api/partner-management/partner-organisation/{partnerOrganisationId}/users HTTP/1.1
Host: your-environment.prod.limio.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "items": [
    {
      "id": "text",
      "name": "text",
      "data": {
        "email": "name@gmail.com"
      },
      "partner_org": "text",
      "record_type": "partner_user",
      "service": "limio",
      "created": "2026-01-01T00:00:00.000Z",
      "modified": "2026-01-01T00:00:00.000Z"
    }
  ],
  "queryMore": "text"
}

Delete Partner User

delete

Delete a specific user from a partner organisation

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

partnerOrganisationIdstringRequired

Partner organisation ID

partnerUserIdstringRequired

Partner user ID

Responses

200

Deleted

application/json

successbooleanOptionalExample: true

401

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

application/json

404

No partner user exists with the given ID

application/json

500

Returned when the partner user exists but belongs to a different partner organisation. The response body is generic and does not identify the cause.

application/json

delete/partner-management/partner-organisation/{partnerOrganisationId}/{partnerUserId}

DELETE /api/partner-management/partner-organisation/{partnerOrganisationId}/{partnerUserId} HTTP/1.1
Host: your-environment.prod.limio.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "success": true
}

PreviousPartner Portal API NextPartner Checkout

Last updated 5 days ago

Was this helpful?