Skip to main content

Backend BillingPlan object

Important

Billing regularly introduces new features and UI changes to Clerk's components. If you'd like to remain on a specific version of Clerk's components or SDK, you can follow the steps in the pinning documentation.

The BillingPlan object is similar to the BillingPlanResource object as it holds information about a Plan, as well as methods for managing it. However, the BillingPlan object is different in that it is used in the Backend API and is not directly accessible from the Frontend API.

Properties

  • Name
    annualFee
    Type
    null | BillingMoneyAmount
    Description

    The annual fee of the Plan.

  • Name
    annualMonthlyFee
    Type
    null | BillingMoneyAmount
    Description

    The annual fee of the Plan on a monthly basis.

  • Name
    avatarUrl
    Type
    null | string
    Description

    The URL of the Plan's avatar image.

  • Name
    description
    Type
    null | string
    Description

    The description of the Plan.

  • Name
    features
    Type
    Feature[]
    Description

    The Features the Plan offers.

  • Name
    fee
    Type
    null | BillingMoneyAmount
    Description

    The monthly fee of the Plan.

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

    The type of payer for the Plan.

  • Name
    freeTrialDays
    Type
    null | number
    Description

    The number of free trial days for this plan.

  • Name
    freeTrialEnabled
    Type
    boolean
    Description

    Whether free trial is enabled for this plan.

  • 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
    publiclyVisible
    Type
    boolean
    Description

    Whether the Plan is displayed in the <PricingTable /> component.

  • 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