# Partner Management

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

## List Partner Organisations

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

```json
{"openapi":"3.1.0","info":{"title":"Limio Commerce API","version":"1.0.0"},"tags":[{"name":"Partner Management","description":"Manage partner organisations and their users. Create, update, and delete partner organisations, and manage user access within them."}],"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":{"PartnerOrganisation":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier for the partner organisation"},"name":{"type":"string","description":"Organisation name"},"data":{"type":"object","properties":{"zuoraAccountId":{"type":"string","description":"Associated Zuora account ID"},"isZuoraInvoiceOwner":{"type":"boolean","description":"Whether this organisation owns Zuora invoices"},"salesforceAccountId":{"type":"string","description":"Associated Salesforce account ID"},"logo":{"type":"string","format":"uri","description":"Organisation logo URL"}}},"record_type":{"type":"string","enum":["partner_org"]},"service":{"type":"string"},"created":{"type":"string","format":"date-time"},"modified":{"type":"string","format":"date-time"}}}},"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"}}}}}}}},"paths":{"/partner-management/partner-organisations":{"get":{"operationId":"getPartnerOrganisations","summary":"List Partner Organisations","tags":["Partner Management"],"description":"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.","parameters":[{"name":"limit","in":"query","required":false,"description":"Maximum number of partner organisations to return.","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"items":{"type":"array","description":"List of partner organisations.","items":{"$ref":"#/components/schemas/PartnerOrganisation"}},"queryMore":{"type":"string","description":"Pagination token for the next page of results."}}}}}},"401":{"$ref":"#/components/responses/401Response"}}}}}}
```

## Create Partner Organisation

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

```json
{"openapi":"3.1.0","info":{"title":"Limio Commerce API","version":"1.0.0"},"tags":[{"name":"Partner Management","description":"Manage partner organisations and their users. Create, update, and delete partner organisations, and manage user access within them."}],"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":{"PartnerOrganisation":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier for the partner organisation"},"name":{"type":"string","description":"Organisation name"},"data":{"type":"object","properties":{"zuoraAccountId":{"type":"string","description":"Associated Zuora account ID"},"isZuoraInvoiceOwner":{"type":"boolean","description":"Whether this organisation owns Zuora invoices"},"salesforceAccountId":{"type":"string","description":"Associated Salesforce account ID"},"logo":{"type":"string","format":"uri","description":"Organisation logo URL"}}},"record_type":{"type":"string","enum":["partner_org"]},"service":{"type":"string"},"created":{"type":"string","format":"date-time"},"modified":{"type":"string","format":"date-time"}}}},"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"}}}}}}}},"paths":{"/partner-management/partner-organisation":{"post":{"operationId":"createPartnerOrganisation","summary":"Create Partner Organisation","tags":["Partner Management"],"description":"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.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["name","zuoraAccountId","isZuoraInvoiceOwner"],"properties":{"name":{"type":"string","description":"Display name of the partner organisation."},"zuoraAccountId":{"type":"string","description":"Zuora account ID to link to this partner."},"isZuoraInvoiceOwner":{"type":"boolean","description":"Whether this partner owns invoices in Zuora."},"salesforceAccountId":{"type":"string","description":"Optional Salesforce account ID for CRM integration."},"logo":{"type":"string","format":"uri","description":"URL to the partner organisation's logo."}}}}}},"responses":{"200":{"description":"Partner organisation created successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerOrganisation"}}}},"401":{"$ref":"#/components/responses/401Response"}}}}}}
```

## Create Partner User

> Create a new user for a specific partner organisation

```json
{"openapi":"3.1.0","info":{"title":"Limio Commerce API","version":"1.0.0"},"tags":[{"name":"Partner Management","description":"Manage partner organisations and their users. Create, update, and delete partner organisations, and manage user access within them."}],"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":{"PartnerUser":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier for the partner user"},"name":{"type":"string","description":"User identifier (typically email)"},"data":{"type":"object","properties":{"email":{"type":"string","format":"email","description":"User email address"}}},"partner_org":{"type":"string","description":"Associated partner organisation ID"},"record_type":{"type":"string","enum":["partner_user"]},"service":{"type":"string"},"created":{"type":"string","format":"date-time"},"modified":{"type":"string","format":"date-time"}}}},"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"}}}}}}}},"paths":{"/partner-management/partner-organisation/{partnerOrganisationId}":{"post":{"operationId":"createPartnerUserForOrganisation","summary":"Create Partner User","tags":["Partner Management"],"description":"Create a new user for a specific partner organisation","parameters":[{"name":"partnerOrganisationId","in":"path","required":true,"schema":{"type":"string"},"description":"Partner organisation ID"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","description":"User email address"}}}}}},"responses":{"200":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerUser"}}}},"401":{"$ref":"#/components/responses/401Response"}}}}}}
```

## Update Partner Organisation

> Update an existing partner organisation's details

```json
{"openapi":"3.1.0","info":{"title":"Limio Commerce API","version":"1.0.0"},"tags":[{"name":"Partner Management","description":"Manage partner organisations and their users. Create, update, and delete partner organisations, and manage user access within them."}],"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":{"PartnerOrganisation":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier for the partner organisation"},"name":{"type":"string","description":"Organisation name"},"data":{"type":"object","properties":{"zuoraAccountId":{"type":"string","description":"Associated Zuora account ID"},"isZuoraInvoiceOwner":{"type":"boolean","description":"Whether this organisation owns Zuora invoices"},"salesforceAccountId":{"type":"string","description":"Associated Salesforce account ID"},"logo":{"type":"string","format":"uri","description":"Organisation logo URL"}}},"record_type":{"type":"string","enum":["partner_org"]},"service":{"type":"string"},"created":{"type":"string","format":"date-time"},"modified":{"type":"string","format":"date-time"}}}},"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"}}}}}}}},"paths":{"/partner-management/partner-organisation/{partnerOrganisationId}":{"put":{"operationId":"updatePartnerOrganisation","summary":"Update Partner Organisation","tags":["Partner Management"],"description":"Update an existing partner organisation's details","parameters":[{"name":"partnerOrganisationId","in":"path","required":true,"schema":{"type":"string"},"description":"Partner organisation ID"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"zuoraAccountId":{"type":"string","description":"Associated Zuora account ID"},"isZuoraInvoiceOwner":{"type":"boolean","description":"Whether this organisation owns Zuora invoices"},"salesforceAccountId":{"type":"string","description":"Associated Salesforce account ID"},"logo":{"type":"string","format":"uri","description":"Organisation logo URL"}}}}}},"responses":{"200":{"description":"Updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerOrganisation"}}}},"401":{"$ref":"#/components/responses/401Response"}}}}}}
```

## Delete Partner Organisation

> Delete a partner organisation and all associated users

```json
{"openapi":"3.1.0","info":{"title":"Limio Commerce API","version":"1.0.0"},"tags":[{"name":"Partner Management","description":"Manage partner organisations and their users. Create, update, and delete partner organisations, and manage user access within them."}],"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>`"}},"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"}}}}}}}},"paths":{"/partner-management/partner-organisation/{partnerOrganisationId}":{"delete":{"operationId":"deletePartnerOrganisation","summary":"Delete Partner Organisation","tags":["Partner Management"],"description":"Delete a partner organisation and all associated users","parameters":[{"name":"partnerOrganisationId","in":"path","required":true,"schema":{"type":"string"},"description":"Partner organisation ID"}],"responses":{"200":{"description":"Deleted","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean"}}}}}},"401":{"$ref":"#/components/responses/401Response"}}}}}}
```

## List Partner Users for Organisation

> Retrieve all users associated with a specific partner organisation

```json
{"openapi":"3.1.0","info":{"title":"Limio Commerce API","version":"1.0.0"},"tags":[{"name":"Partner Management","description":"Manage partner organisations and their users. Create, update, and delete partner organisations, and manage user access within them."}],"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":{"PartnerUser":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier for the partner user"},"name":{"type":"string","description":"User identifier (typically email)"},"data":{"type":"object","properties":{"email":{"type":"string","format":"email","description":"User email address"}}},"partner_org":{"type":"string","description":"Associated partner organisation ID"},"record_type":{"type":"string","enum":["partner_user"]},"service":{"type":"string"},"created":{"type":"string","format":"date-time"},"modified":{"type":"string","format":"date-time"}}}},"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"}}}}}}}},"paths":{"/partner-management/partner-organisation/{partnerOrganisationId}/users":{"get":{"operationId":"getPartnerUsersForOrganisation","summary":"List Partner Users for Organisation","tags":["Partner Management"],"description":"Retrieve all users associated with a specific partner organisation","parameters":[{"name":"partnerOrganisationId","in":"path","required":true,"schema":{"type":"string"},"description":"Partner organisation ID"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/PartnerUser"}},"queryMore":{"type":"string","description":"Token for next page of results"}}}}}},"401":{"$ref":"#/components/responses/401Response"}}}}}}
```

## Delete Partner User

> Delete a specific user from a partner organisation

```json
{"openapi":"3.1.0","info":{"title":"Limio Commerce API","version":"1.0.0"},"tags":[{"name":"Partner Management","description":"Manage partner organisations and their users. Create, update, and delete partner organisations, and manage user access within them."}],"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>`"}},"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"}}}}}}}},"paths":{"/partner-management/partner-organisation/{partnerOrganisationId}/{partnerUserId}":{"delete":{"operationId":"deletePartnerUser","summary":"Delete Partner User","tags":["Partner Management"],"description":"Delete a specific user from a partner organisation","parameters":[{"name":"partnerOrganisationId","in":"path","required":true,"schema":{"type":"string"},"description":"Partner organisation ID"},{"name":"partnerUserId","in":"path","required":true,"schema":{"type":"string"},"description":"Partner user ID"}],"responses":{"200":{"description":"Deleted","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean"}}}}}},"401":{"$ref":"#/components/responses/401Response"}}}}}}
```