Skip to main content
Docs

CommercePlan

Warning

This API is experimental and subject to change while Clerk Billing is under Beta. To mitigate potential disruptions, we recommend pinning your SDK and clerk-js package versions.

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

Properties

  • Name
    id
    Type
    string
    Description

    The unique identifier for the plan.

  • Name
    productId
    Type
    string
    Description

    The ID of the product the plan belongs to.

  • Name
    name
    Type
    string
    Description

    The name of the plan.

  • Name
    slug
    Type
    string
    Description

    The URL-friendly identifier of the plan.

  • Name
    description
    Type
    undefined | string
    Description

    The description of 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
    hasBaseFee
    Type
    boolean
    Description

    Whether the plan has a base fee.

  • Name
    publiclyVisible
    Type
    boolean
    Description

    Whether the plan is displayed in the <PriceTable/> component.

  • Name
    fee
    Type
    Description

    The monthly fee of the plan.

  • Name
    annualFee
    Type
    Description

    The annual fee of the plan.

  • Name
    annualMonthlyFee
    Type
    Description

    The annual fee of the plan on a monthly basis.

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

    The type of payer for the plan.

  • Name
    features
    Type
    Feature[]
    Description

    The features the plan offers.

Feedback

What did you think of this content?
Edit this page on GitHub

Last updated on