chore: add jsdoc description to cancel subscription method

stfsy · stfsy · commit c03b6a8d8f3a · 2022-10-12T15:17:51.000+02:00
diff --git a/lib/subscription-info.js b/lib/subscription-info.js
@@ -83,6 +83,8 @@ class SubscriptionInfo {
     }
 
     /**
+     * Will cancel the subscription plan of the given subscription. The actual subscription id
+     * will be looked at at runtime by peaking at all subscription events. 
      * 
      * @param {Object} subscription 
      * @param {String} subscriptionPlanId the plan that should be cancelled

Original file line number	Diff line number	Diff line change
`@@ -83,6 +83,8 @@ class SubscriptionInfo {`
`83`	`83`	`}`
`84`	`84`
`85`	`85`	`/**`
	`86`	`+ * Will cancel the subscription plan of the given subscription. The actual subscription id`
	`87`	`+ * will be looked at at runtime by peaking at all subscription events.`
`86`	`88`	`*`
`87`	`89`	`* @param {Object} subscription`
`88`	`90`	`* @param {String} subscriptionPlanId the plan that should be cancelled`