---
title: "GET /api/subscription"
method: GET
path: "/api/subscription"
tags: ["Subscription"]
---

# GET /api/subscription

`GET /api/subscription`

## Request

- Base URL: `https://api.wearelearning.io` (the document declares no server; this is the origin it was published from)
- URL: `https://api.wearelearning.io/api/subscription`
- Auth: OAuth 2
  - Implicit: `https://login.wearelearning.io/authorize?audience=https://api.wearelearning.io`

## Response `200`

OK

- SubscriptionDto
  - `plan` PlanDtoV2, required
    - `planType` 'SingleCreator' | 'SmallBusiness' | 'Enterprise', required
    - `addons` PlanAddonDto[], required
      - `type` 'Creators' | 'PublishedStories' | 'Languages' | 'Characters', required
      - `currentUsage` integer, required
      - `available` integer, required
      - `extras` integer, required
      - `nextBillingCycleExtras` integer, required
      - `isUnlimited` boolean, required
      - `canBuyExtras` boolean, required
  - `state` SubscriptionStateDto
    - `status` 'Trial' | 'Active' | 'Inactive', required
    - `trialEndDate` string, date-time, nullable
    - `inactivityReason` 'TrialExpired' | 'Overdue' | 'Unpaid' | 'Paused' | 'Cancelled'
  - `billingDetails` SubscriptionBillingDetailsDto, required
    - `period` 'Monthly' | 'Annual', required
    - `currency` 'USD' | 'EUR' | 'NOK', required
    - `paymentMethod` PaymentMethodDto
      - `externalId` string, required
      - `last4Digits` string, required
    - `currentBillingCycleEnd` string, date-time, nullable
  - `canManageExtras` boolean, nullable
  - `hasFullFeatureAccess` boolean, required

---

[API](https://skmtc.dev/wearelearning/apis/we-are-learning-api.md) - [All operations](https://skmtc.dev/wearelearning/apis/we-are-learning-api/llms.txt) - [OpenAPI document](https://skmtc.dev/wearelearning/apis/we-are-learning-api/revisions/e2ca5265db77?raw)