Skip to main content
Docs

FeatureResource

Warning

Billing is currently in Beta and its APIs are experimental and may undergo breaking changes. To mitigate potential disruptions, we recommend pinning your SDK and clerk-js package versions.

The FeatureResource type represents a feature of a plan.

Properties

  • Name
    avatarUrl
    Type
    null | string
    Description

    The URL of the feature's avatar image, or null if not set.

  • Name
    description
    Type
    null | string
    Description

    A short description of what the feature provides, or null if not provided.

  • Name
    id
    Type
    string
    Description

    The unique identifier for the feature.

  • Name
    name
    Type
    string
    Description

    The display name of the feature.

  • Name
    pathRoot
    Type
    string
    Description

    The root path of the resource.

  • Name
    slug
    Type
    string
    Description

    A unique, URL-friendly identifier for the feature.

Feedback

What did you think of this content?
GitHubEdit on GitHub

Last updated on