Add trial_ends_at for updateSubscription and skip_trial for `ch…

…eckoutOptions` in the `createCheckout` function (#75) * feat(subscriptions): add trial_ends_at for the updateSubscription function * feat: add skip_trial for createCheckout function * docs: update changeset * test(checkouts): remove skip
lmsqueezy · Apr 19, 2024 · b4d071a · b4d071a
1 parent 09fdd1a
commit b4d071a
Show file tree

Hide file tree

Showing 6 changed files with 64 additions and 0 deletions.
diff --git a/.changeset/swift-crabs-train.md b/.changeset/swift-crabs-train.md
@@ -0,0 +1,6 @@
+---
+"@lemonsqueezy/lemonsqueezy.js": patch
+---
+
+Add `trial_ends_at` for `updateSubscription` function;
+Add `skip_trial` for `checkoutOptions` in the `createCheckout` function;
diff --git a/src/checkouts/types.ts b/src/checkouts/types.ts
@@ -82,6 +82,10 @@ type CheckoutOptions = {
    * If `false`, hide the discount code field
    */
   discount: boolean;
+  /**
+   *  If `true`, remove the free trial
+   */
+  skip_trial: boolean;
   quantity: number;
   /**
    * If `true`, use the dark theme
@@ -413,6 +417,10 @@ export type NewCheckout = {
      *  If `false`, hide the discount code field
      */
     discount?: boolean;
+    /**
+     *  If `true`, remove the free trial
+     */
+    skipTrial?: boolean;
     /**
      * If `true`, use the dark theme
      */

diff --git a/src/subscriptions/index.ts b/src/subscriptions/index.ts
@@ -50,6 +50,7 @@ export function updateSubscription(
     invoiceImmediately,
     disableProrations,
     pause,
+    trialEndsAt,
   } = updateSubscription;
 
   const attributes = convertKeys({
@@ -59,6 +60,7 @@ export function updateSubscription(
     invoiceImmediately,
     disableProrations,
     pause,
+    trialEndsAt,
   });
 
   return $fetch<Subscription>({

diff --git a/src/subscriptions/types.ts b/src/subscriptions/types.ts
@@ -293,6 +293,10 @@ export type UpdateSubscription = Partial<{
    * Set as `true` to cancel the subscription. You can resume a subscription (before the `ends_at` date) by setting this to `false`.
    */
   cancelled: boolean;
+  /**
+   * An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) formatted date-time string indicating when the subscription's free trial should end.
+   */
+  trialEndsAt: string | null;
   /**
    * - Use an integer representing a day of the month (`21` equals `21st day of the month`) to change the day on which subscription invoice payments are collected.
    * - Use `null` or `0` to reset the billing anchor to the current date. Doing this will also remove an active trial.

diff --git a/test/checkouts/index.test.ts b/test/checkouts/index.test.ts
@@ -127,6 +127,7 @@ describe("Create a checkout", () => {
       logo,
       desc,
       discount,
+      skip_trial,
       quantity,
       dark,
       subscription_preview,
@@ -138,6 +139,7 @@ describe("Create a checkout", () => {
       logo,
       desc,
       discount,
+      skip_trial,
       quantity,
       dark,
       subscription_preview,
@@ -242,6 +244,7 @@ describe("Create a checkout", () => {
         logo: true,
         desc: true,
         dark: true,
+        skipTrial: true,
         discount: false,
         buttonColor: "#ccc",
         subscriptionPreview: true,
@@ -367,6 +370,7 @@ describe("Create a checkout", () => {
       logo,
       desc,
       discount,
+      skip_trial,
       quantity,
       dark,
       subscription_preview,
@@ -378,6 +382,7 @@ describe("Create a checkout", () => {
       logo,
       desc,
       discount,
+      skip_trial,
       quantity,
       dark,
       subscription_preview,

diff --git a/test/subscriptions/index.test.ts b/test/subscriptions/index.test.ts
@@ -30,6 +30,7 @@ describe("List all subscriptions", () => {
     expect(_data).toBeDefined();
 
     const { meta, links, data } = _data!;
+
     expect(meta.page).toBeDefined();
     expect(links.first).toBeString();
     expect(links.last).toBeString();
@@ -609,6 +610,44 @@ describe("Update a subscription", () => {
     expect(cancelled).toBeFalse();
   });
 
+  it("The subscription should be changed to trial_ends_at", async () => {
+    function formatISO8601(isoString: string) {
+      const date = new Date(isoString);
+      const year = date.getFullYear();
+      const month = String(date.getMonth() + 1).padStart(2, "0");
+      const day = String(date.getDate()).padStart(2, "0");
+      const hours = String(date.getHours()).padStart(2, "0");
+      const minutes = String(date.getMinutes()).padStart(2, "0");
+      const seconds = String(date.getSeconds()).padStart(2, "0");
+
+      return `${year}-${month}-${day} ${hours}:${minutes}:${seconds}`;
+    }
+    const trialEndsAt = new Date("2024-04-25").toISOString();
+    const {
+      statusCode,
+      error,
+      data: _data,
+    } = await updateSubscription(subscriptionId, {
+      trialEndsAt,
+    });
+
+    expect(statusCode).toEqual(200);
+    expect(error).toBeNull();
+    expect(_data).toBeDefined();
+
+    const { data, links } = _data!;
+    expect(data).toBeDefined();
+    expect(links.self).toEqual(`${API_BASE_URL}${PATH}${subscriptionId}`);
+
+    const { id, type, attributes } = data;
+    expect(id).toEqual(subscriptionId.toString());
+    expect(type).toBe(DATA_TYPE);
+    expect(attributes).toBeDefined();
+
+    const { trial_ends_at } = attributes;
+    expect(formatISO8601(trial_ends_at!)).toEqual(formatISO8601(trialEndsAt));
+  });
+
   it("The payment should be changed to pause", async () => {
     const mode = "void";
     const billingAnchor = 25;