---
title: "Get kept and lost brands on subscription downgrade"
method: GET
path: "/v2/settings/subscriptions/comparison"
tags: ["Subscriptions Api Service"]
---

# Get kept and lost brands on subscription downgrade

`GET /v2/settings/subscriptions/comparison`

## Request

- Base URL: `https://app.metricool.com/api`
- URL: `https://app.metricool.com/api/v2/settings/subscriptions/comparison`
- Auth: none declared

## Query parameters

- `subscriptionPlanId` string, required

## Response `200`

Brands comparison with kept and lost lists

- JsonOkResponseSubscriptionDowngradeBrandsLostComparisonResult
  - `metadata` object
  - `page` JsonPaging
    - `next` string
  - `data` SubscriptionDowngradeBrandsLostComparisonResult: Brands comparison result for a subscription downgrade
    - `keptBrands` BrandLite[]: Brands the user will keep after the downgrade
      - `id` integer
      - `userId` integer
      - `ownerUserId` integer
      - `label` string
      - `title` string
      - `description` string
      - `image` string
      - `ownerUsername` string
      - `hash` string
      - `joinDate` DateTimeInfo
        - `dateTime` string, required: Local Date-time represented with a certain timezone
        - `timezone` string: Timezone applied to the datetime
      - `firstConnectionDate` DateTimeInfo
        - `dateTime` string, required: Local Date-time represented with a certain timezone
        - `timezone` string: Timezone applied to the datetime
      - `timezone` string
      - `brandRole` BrandRole
        - `id` integer
        - `userId` integer, required
        - `name` string, required
        - `description` string
        - `color` string
        - `type` string
        - `assignable` boolean
        - `teamMemberOnly` boolean
        - `deletedDate` DateTimeInfo
          - `dateTime` string, required: Local Date-time represented with a certain timezone
          - `timezone` string: Timezone applied to the datetime
        - `deleted` boolean
        - `actions` BrandRoleActions, required
          - `viewAnalytics` boolean
          - `viewInbox` boolean
          - `viewPlanner` boolean
          - `viewAds` boolean
          - `viewSmartlinks` boolean
          - `fullAccessReports` boolean
          - `fullAccessInbox` boolean
          - `fullAccessPlanner` boolean
          - `fullAccessAds` boolean
          - `fullAccessSmartlinks` boolean
          - `fullAccessHashtagTracker` boolean
          - `editBrand` boolean
          - `schedulePosts` boolean
          - `publishPosts` boolean
          - `approvePosts` boolean
          - `viewCondensedAnalytics` boolean
          - `fullAccessDashboards` boolean
          - `viewDashboards` boolean
          - `editFlow` boolean
          - `viewFlow` boolean
          - `fullAccessStudio` boolean
        - `organizationActions` OrganizationRoleActionsDto, required: Organization-level permissions granted by a brand role, on top of the per-brand actions. Never null in a read response - a role that never had organization permissions set is reported with every field false.
          - `manageBrands` boolean: Whether the role can create and manage brands at the organization level.
          - `manageRoles` boolean: Whether the role can create and manage other brand roles at the organization level.
          - `manageTeamMembers` boolean: Whether the role can manage team members at the organization level.
          - `manageAgencyConfig` boolean: Whether the role can manage the agency configuration.
          - `manageAgencyClients` boolean: Whether the role can manage agency clients.
        - `assignedUsersCount` integer
        - `assignedEnabledCount` integer
        - `assignedDisabledCount` integer
      - `engagementRatio` integer
      - `networksData` NetworksData
        - `webData` string
        - `facebookData` string
        - `instagramData` string
        - `threadsData` string
        - `blueskyData` string
        - `twitterData` string
        - `linkedinData` string
        - `pinterestData` string
        - `tiktokData` string
        - `gbpData` string
        - `youtubeData` string
        - `twitchData` string
        - `facebookAdsData` string
        - `googleAdsData` string
        - `tiktokAdsData` string
      - `isShared` boolean
    - `lostBrands` BrandLite[]: Brands the user will lose after the downgrade
      - `id` integer
      - `userId` integer
      - `ownerUserId` integer
      - `label` string
      - `title` string
      - `description` string
      - `image` string
      - `ownerUsername` string
      - `hash` string
      - `joinDate` DateTimeInfo
        - `dateTime` string, required: Local Date-time represented with a certain timezone
        - `timezone` string: Timezone applied to the datetime
      - `firstConnectionDate` DateTimeInfo
        - `dateTime` string, required: Local Date-time represented with a certain timezone
        - `timezone` string: Timezone applied to the datetime
      - `timezone` string
      - `brandRole` BrandRole
        - `id` integer
        - `userId` integer, required
        - `name` string, required
        - `description` string
        - `color` string
        - `type` string
        - `assignable` boolean
        - `teamMemberOnly` boolean
        - `deletedDate` DateTimeInfo
          - `dateTime` string, required: Local Date-time represented with a certain timezone
          - `timezone` string: Timezone applied to the datetime
        - `deleted` boolean
        - `actions` BrandRoleActions, required
          - `viewAnalytics` boolean
          - `viewInbox` boolean
          - `viewPlanner` boolean
          - `viewAds` boolean
          - `viewSmartlinks` boolean
          - `fullAccessReports` boolean
          - `fullAccessInbox` boolean
          - `fullAccessPlanner` boolean
          - `fullAccessAds` boolean
          - `fullAccessSmartlinks` boolean
          - `fullAccessHashtagTracker` boolean
          - `editBrand` boolean
          - `schedulePosts` boolean
          - `publishPosts` boolean
          - `approvePosts` boolean
          - `viewCondensedAnalytics` boolean
          - `fullAccessDashboards` boolean
          - `viewDashboards` boolean
          - `editFlow` boolean
          - `viewFlow` boolean
          - `fullAccessStudio` boolean
        - `organizationActions` OrganizationRoleActionsDto, required: Organization-level permissions granted by a brand role, on top of the per-brand actions. Never null in a read response - a role that never had organization permissions set is reported with every field false.
          - `manageBrands` boolean: Whether the role can create and manage brands at the organization level.
          - `manageRoles` boolean: Whether the role can create and manage other brand roles at the organization level.
          - `manageTeamMembers` boolean: Whether the role can manage team members at the organization level.
          - `manageAgencyConfig` boolean: Whether the role can manage the agency configuration.
          - `manageAgencyClients` boolean: Whether the role can manage agency clients.
        - `assignedUsersCount` integer
        - `assignedEnabledCount` integer
        - `assignedDisabledCount` integer
      - `engagementRatio` integer
      - `networksData` NetworksData
        - `webData` string
        - `facebookData` string
        - `instagramData` string
        - `threadsData` string
        - `blueskyData` string
        - `twitterData` string
        - `linkedinData` string
        - `pinterestData` string
        - `tiktokData` string
        - `gbpData` string
        - `youtubeData` string
        - `twitchData` string
        - `facebookAdsData` string
        - `googleAdsData` string
        - `tiktokAdsData` string
      - `isShared` boolean

---

[API](https://skmtc.dev/metricool/apis/metricool-api.md) · [All operations](https://skmtc.dev/metricool/apis/metricool-api/llms.txt) · [OpenAPI document](https://skmtc.dev/metricool/apis/metricool-api/revisions/acd39d094f11?raw)
