Skip to main content
Docs

BillingPlanResource

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 BillingPlanResource type represents a Subscription Plan with its details.

Properties

  • Name
    annualFee
    Type
    null | BillingMoneyAmount
    Description

    The annual price of the Plan or null if the Plan is not annual.

  • Name
    annualMonthlyFee
    Type
    null | BillingMoneyAmount
    Description

    The effective monthly price when billed annually or null if the Plan is not annual.

  • Name
    avatarUrl
    Type
    null | string
    Description

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

  • Name
    description
    Type
    null | string
    Description

    A short description of what the Plan offers, or null if no description is provided.

  • Name
    features
    Type
    FeatureResource[]
    Description

    The Features the Plan offers.

  • Name
    fee
    Type
    BillingMoneyAmount
    Description

    The monthly price of the Plan.

  • Name
    forPayerType
    Type
    "org" | "user"
    Description

    Specifies the subscriber type this Plan is designed for. Each Plan is exclusively created for either individual users or Organizations, and cannot be used interchangeably.

  • Name
    freeTrialDays
    Type
    null | number
    Description

    The number of days of the free trial for the Plan. null if the Plan does not have a free trial.

  • Name
    freeTrialEnabled
    Type
    boolean
    Description

    Whether the Plan has a free trial.

  • Name
    hasBaseFee
    Type
    boolean
    Description

    Whether the Plan has a base fee.

  • Name
    id
    Type
    string
    Description

    The unique identifier for the Plan.

  • Name
    isDefault
    Type
    boolean
    Description

    Whether the Plan is the default Plan.

  • Name
    isRecurring
    Type
    boolean
    Description

    Whether the Plan is recurring.

  • Name
    name
    Type
    string
    Description

    The name of the Plan.

  • Name
    pathRoot
    Type
    string
    Description

    The root path of the resource.

  • Name
    publiclyVisible
    Type
    boolean
    Description

    Whether the Plan is visible to the public.

  • Name
    slug
    Type
    string
    Description

    The URL-friendly identifier of the Plan.

Feedback

What did you think of this content?

Last updated on

GitHubEdit on GitHub