@clerk/shared 4.0.0-canary.v20260107202600 → 4.0.0-canary.v20260108154421

package/dist/types/index.d.ts

@@ -347,10 +347,14 @@ type WithOptionalOrgType<T$1> = T$1 & {
  */
 interface BillingNamespace {
   /**
+   * Returns a list of payment attempts for the current user or supplied organization.
+   *
    * @experimental This is an experimental API for the Billing feature that is available under a public beta, and the API is subject to change. It is advised to [pin](https://clerk.com/docs/pinning) the SDK version and the clerk-js version to avoid breaking changes.
    */
   getPaymentAttempts: (params: GetPaymentAttemptsParams) => Promise<ClerkPaginatedResponse<BillingPaymentResource>>;
   /**
+   * Returns details of a specific payment attempt for the current user or supplied organization.
+   *
    * @experimental This is an experimental API for the Billing feature that is available under a public beta, and the API is subject to change. It is advised to [pin](https://clerk.com/docs/pinning) the SDK version and the clerk-js version to avoid breaking changes.
    */
   getPaymentAttempt: (params: {
@@ -358,24 +362,34 @@ interface BillingNamespace {
     orgId?: string;
   }) => Promise<BillingPaymentResource>;
   /**
+   * Returns a list of all publically visible billing plans.
+   *
    * @experimental This is an experimental API for the Billing feature that is available under a public beta, and the API is subject to change. It is advised to [pin](https://clerk.com/docs/pinning) the SDK version and the clerk-js version to avoid breaking changes.
    */
   getPlans: (params?: GetPlansParams) => Promise<ClerkPaginatedResponse<BillingPlanResource>>;
   /**
+   * Returns a billing plan by ID.
+   *
    * @experimental This is an experimental API for the Billing feature that is available under a public beta, and the API is subject to change. It is advised to [pin](https://clerk.com/docs/pinning) the SDK version and the clerk-js version to avoid breaking changes.
    */
   getPlan: (params: {
     id: string;
   }) => Promise<BillingPlanResource>;
   /**
+   * Returns the main billing subscription for the current user or supplied organization.
+   *
    * @experimental This is an experimental API for the Billing feature that is available under a public beta, and the API is subject to change. It is advised to [pin](https://clerk.com/docs/pinning) the SDK version and the clerk-js version to avoid breaking changes.
    */
   getSubscription: (params: GetSubscriptionParams) => Promise<BillingSubscriptionResource>;
   /**
+   * Returns a list of billing statements for the current user or supplied organization.
+   *
    * @experimental This is an experimental API for the Billing feature that is available under a public beta, and the API is subject to change. It is advised to [pin](https://clerk.com/docs/pinning) the SDK version and the clerk-js version to avoid breaking changes.
    */
   getStatements: (params: GetStatementsParams) => Promise<ClerkPaginatedResponse<BillingStatementResource>>;
   /**
+   * Returns a billing statement by ID.
+   *
    * @experimental This is an experimental API for the Billing feature that is available under a public beta, and the API is subject to change. It is advised to [pin](https://clerk.com/docs/pinning) the SDK version and the clerk-js version to avoid breaking changes.
    */
   getStatement: (params: {
@@ -383,6 +397,8 @@ interface BillingNamespace {
     orgId?: string;
   }) => Promise<BillingStatementResource>;
   /**
+   * Creates a new billing checkout for the current user or supplied organization.
+   *
    * @experimental This is an experimental API for the Billing feature that is available under a public beta, and the API is subject to change. It is advised to [pin](https://clerk.com/docs/pinning) the SDK version and the clerk-js version to avoid breaking changes.
    */
   startCheckout: (params: CreateCheckoutParams) => Promise<BillingCheckoutResource>;