Interface WKUserSubscription

Details about the user's subscription state.

See

https://docs.api.wanikani.com/20170710/#user

interface WKUserSubscription {
    active: boolean;
    max_level_granted: 3 | 60;
    period_ends_at: null | WKDatableString;
    type:
        | "free"
        | "lifetime"
        | "recurring"
        | "unknown";
}

Properties

active max_level_granted period_ends_at type

Properties

active

active: boolean

Whether or not the user currently has a paid subscription.

max_level_granted

max_level_granted: 3 | 60

The maximum level of content accessible to the user for lessons, reviews, and content review. For unsubscribed/free users, the maximum level is 3. For subscribed users, this is 60.

Any application that uses data from the WaniKani API must respect these access limits.

period_ends_at

period_ends_at: null | WKDatableString

The date when the user's subscription period ends. If the user has subscription type lifetime or free then the value is null.

type

type:
    | "free"
    | "lifetime"
    | "recurring"
    | "unknown"

The type of subscription the user has. Options are following: free, recurring, and lifetime. A type of unknown means the user subscription state isn't exactly known. This is a weird state on WaniKani, should be treated as free, and reported to the WaniKani developers.

Settings

On This Page

Properties