Skip to main content
Docs

CommercePlanResource

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 CommercePlanResource type represents a subscription plan with its details.

Properties

  • Name
    id
    Type
    string
    Description

    The unique identifier for the plan.

  • Name
    name
    Type
    string
    Description

    The display name of the plan.

  • Name
    amount
    Type
    number
    Description

    The price of the plan for a single billing period (usually monthly). For example, 1000 for $10.00.

  • Name
    amountFormatted
    Type
    string
    Description

    The formatted price for a single billing period. For example, 10 for $10.00.

  • Name
    annualAmount
    Type
    number
    Description

    The total price for a full year of the plan, in the smallest unit of the currency. For example, 10000 for $100.00.

  • Name
    annualAmountFormatted
    Type
    string
    Description

    The formatted price for a full year of the plan. For example, 100 for $100.00.

  • Name
    annualMonthlyAmount
    Type
    number
    Description

    The effective monthly price when billed annually, in the smallest unit of the currency. For example, 833 for $8.33.

  • Name
    annualMonthlyAmountFormatted
    Type
    string
    Description

    The formatted effective monthly price when billed annually. For example, 8.33 for $8.33.

  • Name
    currencySymbol
    Type
    string
    Description

    The symbol for the plan's currency. For example, $ or €.

  • Name
    currency
    Type
    string
    Description

    The ISO currency code for the plan. For example, USD or EUR.

  • Name
    description
    Type
    string
    Description

    A short description of what the plan offers.

  • Name
    isDefault
    Type
    boolean
    Description

    A boolean that indicates if this plan is the default plan.

  • Name
    isRecurring
    Type
    boolean
    Description

    A boolean that indicates if the plan is billed on a recurring basis.

  • Name
    hasBaseFee
    Type
    boolean
    Description

    A boolean that indicates if the plan has a base fee.

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

    The type of payer this plan is for.

  • Name
    publiclyVisible
    Type
    boolean
    Description

    A boolean that indicates if the plan is visible to the public.

  • Name
    slug
    Type
    string
    Description

    A unique, URL-friendly identifier for the plan.

  • Name
    avatarUrl
    Type
    string
    Description

    The URL of the plan's avatar image.

  • Name
    features
    Type
    CommerceFeatureResource[]
    Description

    The list of features included in this plan.

Feedback

What did you think of this content?
GitHubEdit on GitHub

Last updated on