feat: renames planName to planId and deprecates planName

chargebee · Oct 6, 2020 · 3481e78 · 3481e78
1 parent a8e32e6
commit 3481e78
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 2 deletions.
diff --git a/src/interfaces/cb-types.ts b/src/interfaces/cb-types.ts
@@ -5,7 +5,9 @@ export interface CBCheckoutProps extends CBCheckoutParams {
 
 export type CBCheckoutParams = {
   site: string;
-  planName: string;
+  /** @deprecated since 1.0.7. Use `planId` instead. **/
+  planName?: string;
+  planId?: string;
 } & CBCheckoutQueryParams;
 
 export type CBCheckoutQueryParams = {

diff --git a/src/models/CBCheckout.ts b/src/models/CBCheckout.ts
@@ -23,7 +23,16 @@ export class CBCheckout {
   }
 
   private baseUrl() {
-    return `https://${this.props.site}.chargebee.com/hosted_pages/plans/${this.props.planName}`;
+    return `https://${
+      this.props.site
+    }.chargebee.com/hosted_pages/plans/${this.planResource()}`;
+  }
+
+  private planResource() {
+    if (this.props.planId) {
+      return this.props.planId;
+    }
+    return this.props.planName;
   }
 
   private buildQueryParams() {