ConnectCloud Developers

List the subscriptions a run read (tenant:trade:msp:read)

GET /api/trade/v1/msp/runs/{id}/subscriptions

Module: Trade · operationId: listMspRunSubscriptions · Tag: MSP billing · Auth: access token (Authorization: Bearer <accessToken>)

Read from the run's stored answers, in their order, with the number of usage items the run made of each: for Ingram the subscriptions of the search answers, for Sophos one entry per customer account of the usage rows, for MailStore one per instance (the id is the usage items' sourceCustomer). Runs of other providers are not found.

Parameters

Name In Type Required Description
id path string (uuid) yes

Responses

  • 200 Subscriptions (application/json)
  • 401 No valid session or bearer token (no body).
  • 403 Missing permission, no active tenant in the token, or a missing CSRF token on a cookie write. (application/json)
  • 404 Not found in the tenant. (application/json)

Fields of the 200 answer:

  • month (integer): Month (1–12) of the billing month.
  • provider (string): MSP provider (mailstore, sophos, ingram, itc, …).
  • runId (string (uuid)): Id of the usage run.
  • subscriptions (array of MspRunSubscriptionRow): Subscriptions the run read.
    • billingPeriod (integer): Length of the billing period.
    • billingPeriodUnit (string): Unit of the billing period.
    • endCustomer (string): End customer of the subscription.
    • endCustomerId (string): Ingram end customer id; for Sophos and MailStore the customer number hint.
    • hasDetails (boolean): The run stored the answer of the subscription's details call (Ingram; always true for the other providers).
    • isTrial (boolean): The subscription is a trial.
    • items (integer): Usage items the run made of the subscription.
    • nextBillingDate (string): Ingram next billing date, same format and source as startDate; omitted when unknown.
    • planName (string): Ingram plan; for Sophos the product descriptions of the account's rows, for MailStore MailStore SPE.
    • quantity (number): Quantity.
    • startDate (string): Ingram start date as Ingram sends it (2026-11-15 or 2022-11-11T00:00:00), from the details answer, else the search entry; omitted when unknown.
    • status (string): Status at the provider.
    • subscriptionId (string): Ingram subscription id; for Sophos and MailStore the provider customer (sourceCustomer of the usage items).
  • year (integer): Year of the billing month.

Example 200 answer:

{
  "month": 10,
  "provider": "ingram",
  "runId": "5d6e7f8a-9b0c-4d1e-8f2a-3b4c5d6e7f03",
  "subscriptions": [
    {
      "billingPeriod": 1,
      "billingPeriodUnit": "MONTHS",
      "endCustomer": "Kanzlei Hofmann \u0026 Partner Rechtsanwälte mbB",
      "endCustomerId": "1100430325",
      "hasDetails": true,
      "isTrial": false,
      "items": 1,
      "nextBillingDate": "2026-11-11",
      "planName": "Microsoft 365 Business Standard",
      "quantity": 12,
      "startDate": "2025-11-11T00:00:00",
      "status": "ACTIVE",
      "subscriptionId": "1700012345"
    }
  ],
  "year": 2026
}

Example request

curl -X GET 'https://api.mbcom.cloud/api/trade/v1/msp/runs/3f2b8c1e-7d4a-4e9b-9c2a-5b1d6e8f0a12/subscriptions' \
  -H "Authorization: Bearer $ACCESS_TOKEN"

View as Markdown · Interactive reference · OpenAPI