---
title: "GET /user/settings"
method: GET
path: "/user/settings"
tags: ["User Settings Service"]
---

# GET /user/settings

`GET /user/settings`

## Request

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

## Response `200`

OK

- UserSettings
  - `id` integer
  - `name` string
  - `lastName` string
  - `mail` string
  - `language` string
  - `timezone` string
  - `company` string
  - `country` string
  - `state` string
  - `address` string
  - `vat` string
  - `subscription` Subscription
    - `id` string
    - `provider` string
    - `providerUrl` string
    - `userId` integer
    - `created` string
    - `planId` string
    - `status` string
    - `paymentMethodToken` string
    - `nextPaymentDateInDays` integer
    - `nextPaymentDate` DateTimeInfo
      - `dateTime` string, required: Local Date-time represented with a certain timezone
      - `timezone` string: Timezone applied to the datetime
    - `nextPaymentAmount` number, float
    - `taxData` TaxData
      - `vatRate` number, double
      - `company` string
      - `country` string
      - `state` string
      - `address` string
      - `vatNumber` string
      - `addOn` string
    - `usedProfiles` integer
    - `usedPosts` integer
    - `maxProfiles` integer
    - `maxPosts` integer
    - `maxPostsPerBrand` integer
    - `maxAICreditsPerBrand` integer
    - `plan` SubscriptionPlan
      - `id` string
      - `name` string
      - `billingCycles` integer
      - `price` number, float
      - `profiles` integer
      - `tweets` integer
      - `maxPostsPerBrand` integer
      - `shareProfiles` boolean
      - `whiteLabel` boolean
      - `influencers` boolean
      - `instagramBioLink` boolean
      - `reportTemplate` boolean
      - `currency` string
      - `reportDownload` boolean
      - `historyMaxDays` integer
      - `influencersRestrictions` InfluencersRestrictions
        - `twitter` integer
        - `facebook` integer
        - `youtube` integer
        - `instagram` integer
        - `twitch` integer
      - `stripePriceId` string
      - `level` integer
      - `annualDiscountPercent` number, float
      - `maxAICopiesByBrandPerMonth` integer
      - `api` boolean
      - `dataLockerStudio` boolean
      - `zapier` boolean
      - `addons` object
    - `immediatelyCancelable` boolean
    - `downgradeSubscription` Subscription (recursive)
    - `addons` object
    - `adhocPlan` boolean
    - `trialInProgress` boolean
  - `payment` Payment
    - `id` integer
    - `paymentId` string
    - `subscriptionId` string
    - `description` string
    - `date` DateTimeInfo
      - `dateTime` string, required: Local Date-time represented with a certain timezone
      - `timezone` string: Timezone applied to the datetime
    - `amount` number, float
    - `currency` string
    - `periodStart` DateTimeInfo
      - `dateTime` string, required: Local Date-time represented with a certain timezone
      - `timezone` string: Timezone applied to the datetime
    - `periodEnd` DateTimeInfo
      - `dateTime` string, required: Local Date-time represented with a certain timezone
      - `timezone` string: Timezone applied to the datetime
    - `eurRate` number, double
    - `rateDate` DateTimeInfo
      - `dateTime` string, required: Local Date-time represented with a certain timezone
      - `timezone` string: Timezone applied to the datetime
    - `invoiceNumber` string
    - `paymentType` string
    - `taxData` TaxData
      - `vatRate` number, double
      - `company` string
      - `country` string
      - `state` string
      - `address` string
      - `vatNumber` string
      - `addOn` string
    - `creditNoteData` CreditNoteData
      - `paymentToRefundId` string
      - `paymentToRefundInvoiceNumber` string
      - `paymentToRefundDate` DateTimeInfo
        - `dateTime` string, required: Local Date-time represented with a certain timezone
        - `timezone` string: Timezone applied to the datetime
    - `observations` string
    - `basePlanAmount` number, float
    - `twitterAddonAmount` number, float
    - `discountAmount` number, float
    - `planDescription` string
    - `twitterAddonDescription` string
    - `advancedAnalyticsAddonAmount` number, float
    - `advancedAnalyticsAddonDescription` string
  - `whiteLabelSettings` WhiteLabelSettings
    - `iframeMode` boolean
    - `enabledChat` boolean
    - `footerLogo` string
    - `footerLegalUrl` string
    - `footerContactUrl` string
    - `footerTwitterUrl` string
    - `footerFacebookUrl` string
    - `footerInstagramUrl` string
    - `footerTiktokUrl` string
    - `footerYoutubeUrl` string
    - `footerPinterestUrl` string
    - `loginUrl` string
    - `hideMainMenu` boolean
    - `showAdsMenu` boolean
    - `showPlannerMenu` boolean
    - `showSmartLinksMenu` boolean
    - `showInboxMenu` boolean
    - `showEvolutionMenu` boolean
    - `showReportsMenu` boolean
    - `showAnalyticsSummaryMenu` boolean
    - `showBrandSettingsMenu` boolean
    - `showReportingMenu` boolean
    - `showReportExample` boolean
    - `reportExamplePictureUrl` string
    - `showSubscriptionEmail` boolean
    - `showMessageBackground` boolean
    - `hideBrandedContent` boolean
    - `customizedCssUrl` string
    - `integratorKey` string
    - `colors` object
    - `themeColorPalette` ThemeColorsWithCustomized
      - `topMenuBackgroundColor` string
      - `topMenuTextColor` string
      - `topMenuSeparatorColor` string
      - `primaryButtonBackgroundColor` string
      - `primaryButtonBorderColor` string
      - `primaryButtonTextColor` string
      - `secondaryButtonBackgroundColor` string
      - `secondaryButtonBorderColor` string
      - `secondaryButtonTextColor` string
      - `backgroundColor` string
      - `customizedColors` string[]
    - `reportBackgroundUrl` string
    - `reportBackgroundCoverUrl` string
    - `enabledReportTemplates` boolean
    - `customDomainBaseUrl` string
    - `customSmtpProperties` object
    - `customSesFrom` string
    - `customSesFromLabel` string
  - `sharedWithUser` boolean
  - `vendastaUser` boolean
  - `vendastaSettings` VendastaData
    - `accountId` string
    - `productNavBarDataUrl` string
  - `hashtagBalance` integer
  - `vaxRate` integer
  - `activeBrands` integer
  - `profilePicture` string
  - `whiteLabel` boolean
  - `beta` 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/aea9d9a8415a?raw)