feat: add support for promotion codes and coupons

README.md

@@ -71,6 +71,9 @@ To deploy the sync-engine to a Supabase Edge Function, follow this [guide](./doc
 - [x] `checkout.session.async_payment_succeeded` 🟢
 - [x] `checkout.session.completed` 🟢
 - [x] `checkout.session.expired` 🟢
+- [x] `coupon.created` 🟢
+- [x] `coupon.deleted` 🟢
+- [x] `coupon.updated` 🟢
 - [x] `credit_note.created` 🟢
 - [x] `credit_note.updated` 🟢
 - [x] `credit_note.voided` 🟢
@@ -128,6 +131,8 @@ To deploy the sync-engine to a Supabase Edge Function, follow this [guide](./doc
 - [x] `price.created` 🟢
 - [x] `price.deleted` 🟢
 - [x] `price.updated` 🟢
+- [x] `promotion_code.created` 🟢
+- [x] `promotion_code.updated` 🟢
 - [x] `product.created` 🟢
 - [x] `product.deleted` 🟢
 - [x] `product.updated` 🟢

packages/fastify-app/src/test/helpers/mockStripe.ts

@@ -1,6 +1,27 @@
 import { vitest } from 'vitest'
 
 export const mockStripe = {
+  coupons: {
+    retrieve: vitest.fn((id) =>
+      Promise.resolve({
+        id,
+        object: 'coupon',
+        amount_off: null,
+        created: 1773056115,
+        currency: null,
+        duration: 'once',
+        duration_in_months: null,
+        livemode: false,
+        max_redemptions: null,
+        metadata: {},
+        name: 'TEST_DISCOUNT',
+        percent_off: 100,
+        redeem_by: null,
+        times_redeemed: 0,
+        valid: true,
+      })
+    ),
+  },
   checkout: {
     sessions: {
       retrieve: vitest.fn((id) =>
@@ -95,6 +116,30 @@ export const mockStripe = {
       })),
     },
   },
+  promotionCodes: {
+    retrieve: vitest.fn((id) =>
+      Promise.resolve({
+        id,
+        object: 'promotion_code',
+        active: true,
+        code: 'FREE2026',
+        coupon: '82cOWD3z',
+        created: 1773056115,
+        customer: null,
+        customer_account: null,
+        expires_at: null,
+        livemode: false,
+        max_redemptions: null,
+        metadata: {},
+        restrictions: {
+          first_time_transaction: true,
+          minimum_amount: null,
+          minimum_amount_currency: null,
+        },
+        times_redeemed: 0,
+      })
+    ),
+  },
   invoices: {
     retrieve: vitest.fn((id) =>
       Promise.resolve({

packages/fastify-app/src/test/stripe/coupon_created.json

@@ -0,0 +1,32 @@
+{
+  "id": "evt_1T925fEduqPk9bEEIR3ResAc",
+  "object": "event",
+  "api_version": "2023-10-16",
+  "created": 1773056115,
+  "data": {
+    "object": {
+      "id": "82cOWD3z",
+      "object": "coupon",
+      "amount_off": null,
+      "created": 1773056115,
+      "currency": null,
+      "duration": "once",
+      "duration_in_months": null,
+      "livemode": false,
+      "max_redemptions": null,
+      "metadata": {},
+      "name": "TEST_DISCOUNT",
+      "percent_off": 100,
+      "redeem_by": null,
+      "times_redeemed": 0,
+      "valid": true
+    }
+  },
+  "livemode": false,
+  "pending_webhooks": 1,
+  "request": {
+    "id": "req_hMl8XMocNsAed3",
+    "idempotency_key": "eb42ae66-a11a-47a3-acdd-3ff904f249a5"
+  },
+  "type": "coupon.created"
+}

packages/fastify-app/src/test/stripe/promotion_code_created.json

@@ -0,0 +1,51 @@
+{
+  "id": "evt_1T925fEduqPk9bEEIR3ResAb",
+  "object": "event",
+  "api_version": "2023-10-16",
+  "created": 1773056115,
+  "data": {
+    "object": {
+      "id": "promo_1T925fEduqPk9bEE4b5egICF",
+      "object": "promotion_code",
+      "active": true,
+      "code": "FREE2026",
+      "coupon": {
+        "id": "82cOWD3z",
+        "object": "coupon",
+        "amount_off": null,
+        "created": 1773056115,
+        "currency": null,
+        "duration": "once",
+        "duration_in_months": null,
+        "livemode": false,
+        "max_redemptions": null,
+        "metadata": {},
+        "name": "TEST_DISCOUNT",
+        "percent_off": 100,
+        "redeem_by": null,
+        "times_redeemed": 0,
+        "valid": true
+      },
+      "created": 1773056115,
+      "customer": null,
+      "customer_account": null,
+      "expires_at": null,
+      "livemode": false,
+      "max_redemptions": null,
+      "metadata": {},
+      "restrictions": {
+        "first_time_transaction": true,
+        "minimum_amount": null,
+        "minimum_amount_currency": null
+      },
+      "times_redeemed": 0
+    }
+  },
+  "livemode": false,
+  "pending_webhooks": 1,
+  "request": {
+    "id": "req_hMl8XMocNsAed2",
+    "idempotency_key": "eb42ae66-a11a-47a3-acdd-3ff904f249a4"
+  },
+  "type": "promotion_code.created"
+}

packages/fastify-app/src/test/webhooks.test.ts

@@ -66,6 +66,7 @@ describe('POST /webhooks', () => {
     'customer_deleted.json',
     'customer_tax_id_created.json',
     'customer_tax_id_updated.json',
+    'coupon_created.json',
     'product_created.json',
     'product_updated.json',
     'price_created.json',
@@ -126,6 +127,7 @@ describe('POST /webhooks', () => {
     'refund_updated.json',
     'checkout_session_completed.json',
     'invoice_payment_paid.json',
+    'promotion_code_created.json',
   ])('event %s is upserted', async (jsonFile) => {
     const eventBody = await import(`./stripe/${jsonFile}`).then(({ default: myData }) => myData)
     // Update the event body created timestamp to be the current time

packages/sync-engine/src/database/migrations/0043_promotion_codes.sql

@@ -0,0 +1,28 @@
+create table
+    if not exists "stripe"."promotion_codes" (
+        "id" text primary key,
+        "object" text,
+        "active" boolean,
+        "code" text,
+        "coupon" text,
+        "created" integer,
+        "customer" text,
+        "customer_account" text,
+        "expires_at" integer,
+        "livemode" boolean,
+        "max_redemptions" bigint,
+        "metadata" jsonb,
+        "restrictions" jsonb,
+        "times_redeemed" bigint,
+        "updated_at" timestamptz default timezone('utc'::text, now()) not null,
+        "last_synced_at" timestamptz
+    );
+
+create index stripe_promotion_codes_coupon_idx on "stripe"."promotion_codes" using btree (coupon);
+create index stripe_promotion_codes_customer_idx on "stripe"."promotion_codes" using btree (customer);
+
+create trigger handle_updated_at
+    before update
+    on stripe.promotion_codes
+    for each row
+    execute procedure set_updated_at();

packages/sync-engine/src/schemas/coupon.ts

@@ -0,0 +1,22 @@
+import type { EntitySchema } from './types'
+
+export const couponSchema: EntitySchema = {
+  properties: [
+    'id',
+    'object',
+    'name',
+    'valid',
+    'created',
+    'currency',
+    'duration',
+    'livemode',
+    'metadata',
+    'redeem_by',
+    'amount_off',
+    'percent_off',
+    'times_redeemed',
+    'max_redemptions',
+    'duration_in_months',
+    'percent_off_precise',
+  ],
+} as const

packages/sync-engine/src/schemas/promotion_code.ts

@@ -0,0 +1,20 @@
+import type { EntitySchema } from './types'
+
+export const promotionCodeSchema: EntitySchema = {
+  properties: [
+    'id',
+    'object',
+    'active',
+    'code',
+    'coupon',
+    'created',
+    'customer',
+    'customer_account',
+    'expires_at',
+    'livemode',
+    'max_redemptions',
+    'metadata',
+    'restrictions',
+    'times_redeemed',
+  ],
+} as const