---
title: "GET /v2/settings/subscription/coupon/{couponCode}"
method: GET
path: "/v2/settings/subscription/coupon/{couponCode}"
tags: ["Subscriptions Api Service"]
---

# GET /v2/settings/subscription/coupon/{couponCode}

`GET /v2/settings/subscription/coupon/{couponCode}`

## Request

- Base URL: `https://app.metricool.com/api`
- URL: `https://app.metricool.com/api/v2/settings/subscription/coupon/{couponCode}`
- Auth: none declared

## Path parameters

- `couponCode` string, required

## Query parameters

- `planId` string, required
- `addons.twitter` integer
- `addons.advancedAnalytics` boolean
- `previousBalance` number, double

## Response `200`

OK

- JsonOkResponseCouponResult
  - `metadata` object
  - `page` JsonPaging
    - `next` string
  - `data` CouponResult
    - `finalPriceWithoutTaxes` number, double
    - `isFreeCoupon` boolean
    - `coupon` Coupon
      - `id` integer
      - `code` string
      - `amount` number, float
      - `billingCycles` integer
      - `expiration` DateTimeInfo
        - `dateTime` string, required: Local Date-time represented with a certain timezone
        - `timezone` string: Timezone applied to the datetime
      - `maxDiscounts` integer
      - `forNewUsers` boolean
      - `hashtagsBalance` integer
      - `ownerId` integer
      - `label` string
      - `discountsCount` integer
      - `revenue` number, double
      - `creation` DateTimeInfo
        - `dateTime` string, required: Local Date-time represented with a certain timezone
        - `timezone` string: Timezone applied to the datetime
      - `user` User
        - `id` integer
        - `userName` string
        - `role` string
        - `enabled` boolean
        - `name` string
        - `lastName` string
        - `mail` string
        - `phone` string
        - `language` string
        - `timezone` string
        - `accountLogo` string
        - `headerLogo` string
        - `profilePicture` string: Public URL of the user's 400x400 profile picture. Absent when they have none, in which case the frontend renders its initials fallback.
        - `btCustomerId` string
        - `stripeCustomerId` string
        - `taxData` TaxData
          - `vatRate` number, double
          - `company` string
          - `country` string
          - `state` string
          - `address` string
          - `vatNumber` string
          - `addOn` string
        - `affiliated` boolean
        - `whiteLabel` boolean
        - `academic` boolean
        - `beta` boolean
        - `sendToAlternativeEmail` boolean
        - `alternativeEmail` string
        - `billEmails` string[]
        - `marketingNotifications` boolean
        - `token` string
        - `created` DateTimeInfo
          - `dateTime` string, required: Local Date-time represented with a certain timezone
          - `timezone` string: Timezone applied to the datetime
        - `deleted` DateTimeInfo
          - `dateTime` string, required: Local Date-time represented with a certain timezone
          - `timezone` string: Timezone applied to the datetime
        - `isDeleted` boolean
        - `locked` boolean
        - `changePasswordRequired` boolean
        - `onboarding` OnboardingData
          - `required` boolean
          - `finished` boolean
          - `buyerPersona` string
          - `size` string
          - `goal` string[]
          - `networks` string[]
          - `phone` string
          - `partnersOnboardings` object[]
        - `activeBrands` integer
        - `registeredFromTkAppCenter` boolean
        - `firstDayOfTheWeek` integer
        - `whiteLabelIntegrator` boolean
        - `requiresEmailAddress` boolean
        - `vendastaSettings` VendastaData
          - `accountId` string
          - `productNavBarDataUrl` string
        - `crispWorkspaceId` string
        - `crispTokenId` string: Opaque token identifying this user to Crisp for chat history preservation across login.
        - `agencyCKId` integer
        - `integratedIn` string
        - `accountManagerMail` string
        - `passwordExpirationDate` DateTimeInfo
          - `dateTime` string, required: Local Date-time represented with a certain timezone
          - `timezone` string: Timezone applied to the datetime
        - `blogId` integer
        - `customBrandMail` string
        - `brandLabel` string
        - `userAgencyData` UserAgencyData
          - `agencyId` integer: Unique identifier of the agency
          - `isOwner` boolean: Indicates if the user is the owner of the agency
          - `teamMemberRoleId` integer: Unique identifier of the team member role assigned to the user
          - `agencyOwnerUserId` integer: Unique identifier of the agency owner user
        - `featureSegmentAssigned` FeatureSegmentAssigned[]
          - `name` string, required: Feature name
          - `segmentAssigned` integer, required: Segment assigned to the user
        - `internalTag` string
        - `newsletters` boolean: True when the user accepts commercial communications. Absent when the flag does not apply to the requesting surface; for an account's own info it is always present, and an account with no stored choice reads as true.
      - `percentage` boolean
      - `trial` integer
      - `enabled` boolean
      - `assignedTeamCouponTracking` string
      - `appliedAt` DateTimeInfo
        - `dateTime` string, required: Local Date-time represented with a certain timezone
        - `timezone` string: Timezone applied to the datetime
      - `onlyAnnualPlans` 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)