Skip to main content

getPlanList()

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.

Gets the list of Billing Plans for the instance. By default, the list is returned in descending order by creation date (newest first).

Returns a PaginatedResourceResponse object with a data property containing an array of BillingPlan objects and a totalCount property containing the total number of Billing Plans for the instance.

function getPlanList(params?: GetPlanListParams): Promise<PaginatedResourceResponse<BillingPlan[]>>

GetPlanListParams

  • Name
    limit?
    Type
    number
    Description

    Maximum number of items returned per request. Must be an integer greater than zero and less than 501. Can be used for paginating the results together with offset. Defaults to 10.

  • Name
    offset?
    Type
    number
    Description

    Skip the first offset items when paginating. Needs to be an integer greater or equal to zero. To be used in conjunction with limit. Defaults to 0.

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

    Filters plans by the type of payer.

Usage

Note

Using clerkClient varies based on the SDK you're using. Refer to the overview for usage details, including guidance on how to access the userId and other properties.

const { data, totalCount } = await clerkClient.billing.getPlanList({ payerType: 'org' })

Backend API (BAPI) endpoint

This method in the SDK is a wrapper around the BAPI endpoint GET /billing/plans. See the BAPI reference for more information.

Feedback

What did you think of this content?

Last updated on

GitHubEdit on GitHub