@eventcatalog/create-eventcatalog 4.1.3 → 4.2.0

package/templates/default/domains/Payment/services/FraudDetectionService/index.mdx

@@ -25,7 +25,7 @@ owners:
   - dboyne
 ---
 
-import Footer from '@catalog/components/footer.astro'
+import Footer from '@catalog/components/footer.astro';
 
 ## Overview
 
@@ -42,6 +42,7 @@ The Fraud Detection Service is responsible for analyzing payment transactions in
 ## API Endpoints
 
 ### REST API
+
 - `POST /api/fraud/check` - Submit transaction for fraud check
 - `GET /api/fraud/risk-score/{transactionId}` - Get risk score for transaction
 - `PUT /api/fraud/override/{transactionId}` - Manual override of fraud decision
@@ -55,7 +56,7 @@ fraud_detection:
     medium: 50
     low: 20
   auto_block_threshold: 90
-  ml_model_version: "2.3.1"
+  ml_model_version: '2.3.1'
 ```
 
 <Footer />

package/templates/default/domains/Payment/services/PaymentGatewayService/commands/ProcessPayment/index.mdx

@@ -16,7 +16,7 @@ badges:
 schemaPath: schema.json
 ---
 
-import Footer from '@catalog/components/footer.astro'
+import Footer from '@catalog/components/footer.astro';
 
 ## Overview
 
@@ -25,6 +25,7 @@ The `ProcessPayment` command is used to initiate payment processing through the
 ## Command Sources
 
 This command can be triggered by:
+
 - **BillingService** (Subscriptions Domain) - For recurring subscription payments
 - **OrdersService** (Orders Domain) - For one-time order payments
 - **PaymentService** (Payment Domain) - For payment retries
@@ -37,7 +38,7 @@ sequenceDiagram
     participant PGS as PaymentGatewayService
     participant FDS as FraudDetectionService
     participant EXT as External Gateway
-    
+
     BS->>PGS: ProcessPayment
     PGS->>FDS: Check Fraud
     FDS-->>PGS: Risk Assessment
@@ -71,4 +72,4 @@ sequenceDiagram
 }
 ```
 
-<Footer />
+<Footer />

package/templates/default/domains/Payment/services/PaymentGatewayService/commands/ProcessPayment/schema.json

@@ -55,4 +55,4 @@
     }
   },
   "required": ["paymentId", "amount", "currency", "paymentMethod", "idempotencyKey"]
-}
+}

package/templates/default/domains/Payment/services/PaymentGatewayService/events/PaymentFailed/index.mdx

@@ -12,7 +12,7 @@ badges:
 schemaPath: schema.json
 ---
 
-import Footer from '@catalog/components/footer.astro'
+import Footer from '@catalog/components/footer.astro';
 
 ## Overview
 
@@ -21,6 +21,7 @@ The `PaymentFailed` event is emitted when a payment attempt fails for any reason
 ## Consumers
 
 This event is consumed by:
+
 - **BillingService** (Subscriptions Domain) - To handle subscription payment failures
 - **OrdersService** (Orders Domain) - To handle order payment failures
 - **NotificationService** (Orders Domain) - To notify customers of payment failures
@@ -28,6 +29,7 @@ This event is consumed by:
 ## Failure Reasons
 
 Common failure reasons include:
+
 - **insufficient_funds** - Card has insufficient funds
 - **card_declined** - Card was declined by issuer
 - **expired_card** - Card has expired
@@ -59,4 +61,4 @@ Common failure reasons include:
 }
 ```
 
-<Footer />
+<Footer />

package/templates/default/domains/Payment/services/PaymentGatewayService/events/PaymentFailed/schema.json

@@ -65,4 +65,4 @@
     }
   },
   "required": ["paymentId", "amount", "currency", "failureReason", "timestamp"]
-}
+}

package/templates/default/domains/Payment/services/PaymentGatewayService/index.mdx

@@ -21,7 +21,7 @@ owners:
   - dboyne
 ---
 
-import Footer from '@catalog/components/footer.astro'
+import Footer from '@catalog/components/footer.astro';
 
 ## Overview
 
@@ -46,6 +46,7 @@ The Payment Gateway Service acts as an abstraction layer between our payment sys
 ## API Endpoints
 
 ### REST API
+
 - `POST /api/gateway/authorize` - Authorize a payment
 - `POST /api/gateway/capture` - Capture an authorized payment
 - `POST /api/gateway/refund` - Process a refund
@@ -67,4 +68,4 @@ payment_gateway:
     backoff_ms: 1000
 ```
 
-<Footer />
+<Footer />

package/templates/default/domains/Payment/services/PaymentService/events/PaymentInitiated/index.mdx

@@ -22,7 +22,7 @@ The Payment Initiated event is triggered when a user initiates a payment through
 {
   "userId": "123e4567-e89b-12d3-a456-426614174000",
   "orderId": "789e1234-b56c-78d9-e012-3456789fghij",
-  "amount": 100.50,
+  "amount": 100.5,
   "paymentMethod": "CreditCard",
   "timestamp": "2024-07-04T14:48:00Z"
 }

package/templates/default/domains/Payment/services/PaymentService/events/PaymentProcessed/index.mdx

@@ -23,7 +23,7 @@ The PaymentProcessed event is triggered after the payment has been successfully
   "transactionId": "123e4567-e89b-12d3-a456-426614174000",
   "userId": "123e4567-e89b-12d3-a456-426614174000",
   "orderId": "789e1234-b56c-78d9-e012-3456789fghij",
-  "amount": 100.50,
+  "amount": 100.5,
   "paymentMethod": "CreditCard",
   "status": "confirmed",
   "confirmationDetails": {

package/templates/default/domains/Payment/services/PaymentService/events/PaymentProcessed/versioned/0.0.1/index.mdx

@@ -5,7 +5,7 @@ version: 0.0.1
 schemaPath: schema.json
 summary: Event is triggered after the payment has been successfully processed
 owners:
-    - dboyne
+  - dboyne
 ---
 
 import Footer from '@catalog/components/footer.astro';
@@ -23,7 +23,7 @@ The PaymentProcessed event is triggered after the payment has been successfully
   "transactionId": "123e4567-e89b-12d3-a456-426614174000",
   "userId": "123e4567-e89b-12d3-a456-426614174000",
   "orderId": "789e1234-b56c-78d9-e012-3456789fghij",
-  "amount": 100.50,
+  "amount": 100.5,
   "paymentMethod": "CreditCard",
   "status": "confirmed",
   "confirmationDetails": {
@@ -40,4 +40,4 @@ The PaymentProcessed event is triggered after the payment has been successfully
 - **Sensitive Data Handling**: Avoid including sensitive information (e.g., full credit card numbers) in the event payload. Use secure channels and encryption for such data.
 - **Authentication and Authorization**: Ensure that only authorized services can publish or consume PaymentProcessed events.
 
-<Footer />
+<Footer />

package/templates/default/domains/Payment/services/PaymentService/index.mdx

@@ -31,6 +31,7 @@ The Payment Service is a crucial component of our system that handles all paymen
 <NodeGraph />
 
 ### Key Components
+
 - Payment API: Exposes endpoints for initiating payments and querying payment status.
 - Payment Processor: Handles the core payment processing logic.
 - Event Bus: Manages the communication between services using events.

package/templates/default/domains/Payment/services/PaymentService/queries/GetPaymentStatus/index.mdx

@@ -5,11 +5,11 @@ version: 0.0.1
 summary: |
   GET request that will return the payment status for a specific order, identified by its orderId.
 owners:
-    - dboyne
+  - dboyne
 badges:
-    - content: Recently updated!
-      backgroundColor: green
-      textColor: green
+  - content: Recently updated!
+    backgroundColor: green
+    textColor: green
 schemaPath: schema.json
 ---
 
@@ -23,4 +23,4 @@ This query is useful in scenarios such as order management, refund processing, o
 
 <NodeGraph />
 
-<SchemaViewer file="schema.json" title="JSON Schema" maxHeight="500" />
+<SchemaViewer file="schema.json" title="JSON Schema" maxHeight="500" />

package/templates/default/domains/Payment/services/PaymentService/queries/GetPaymentStatus/schema.json

@@ -1,4 +1,3 @@
-
 {
   "$schema": "http://json-schema.org/draft-07/schema#",
   "title": "GetPaymentStatusResponse",

package/templates/default/domains/Payment/ubiquitous-language.mdx

@@ -2,11 +2,11 @@
 dictionary:
   - id: Transaction
     name: Transaction
-    summary: "The process of transferring funds from one party to another."
+    summary: 'The process of transferring funds from one party to another.'
     icon: CreditCard
   - id: Invoice
     name: Invoice
-    summary: "A document issued by a seller to a buyer, listing goods or services provided and the amount due."
+    summary: 'A document issued by a seller to a buyer, listing goods or services provided and the amount due.'
     description: |
       Invoices are critical for financial transactions, serving as a request for payment from the buyer. They include:
 
@@ -20,7 +20,7 @@ dictionary:
     icon: CreditCard
   - id: Payment Method
     name: Payment Method
-    summary: "The means by which a payment is made, such as credit card or bank transfer."
+    summary: 'The means by which a payment is made, such as credit card or bank transfer.'
     description: |
       Payment methods are the various ways customers can pay for goods or services. Common methods include:
 
@@ -33,7 +33,7 @@ dictionary:
     icon: Wallet
   - id: Receipt
     name: Receipt
-    summary: "A document acknowledging that a payment has been made."
+    summary: 'A document acknowledging that a payment has been made.'
     description: |
       Receipts serve as proof of payment and are important for record-keeping. They typically include:
 
@@ -47,7 +47,7 @@ dictionary:
     icon: Receipt
   - id: Refund
     name: Refund
-    summary: "The process of returning funds to a customer for a returned product or service."
+    summary: 'The process of returning funds to a customer for a returned product or service.'
     description: |
       Refunds are issued when a customer returns a product or cancels a service. The process involves:
 
@@ -59,7 +59,7 @@ dictionary:
     icon: RotateCcw
   - id: Currency
     name: Currency
-    summary: "The system of money in general use in a particular country."
+    summary: 'The system of money in general use in a particular country.'
     description: |
       Currency is the medium of exchange for goods and services. Key aspects include:
 
@@ -71,7 +71,7 @@ dictionary:
     icon: DollarSign
   - id: Payment Gateway
     name: Payment Gateway
-    summary: "A service that authorizes and processes payments for online and offline transactions."
+    summary: 'A service that authorizes and processes payments for online and offline transactions.'
     description: |
       Payment gateways facilitate the transfer of payment information between the customer and the merchant. They ensure secure and efficient transactions by:
 
@@ -83,7 +83,7 @@ dictionary:
     icon: Server
   - id: Chargeback
     name: Chargeback
-    summary: "A demand by a credit card provider for a retailer to make good the loss on a fraudulent or disputed transaction."
+    summary: 'A demand by a credit card provider for a retailer to make good the loss on a fraudulent or disputed transaction.'
     description: |
       Chargebacks occur when a customer disputes a transaction, and the funds are returned to their account. The process involves:
 

package/templates/default/domains/ProductCatalog/entities/Category/index.mdx

@@ -92,13 +92,14 @@ properties:
 The Category entity organizes products into a hierarchical structure, supporting multi-level categorization. It enables efficient product discovery and navigation through the e-commerce catalog.
 
 ### Entity Properties
+
 <EntityPropertiesTable />
 
 ## Relationships
 
-* **Parent Category:** Each category can have one parent `Category` (identified by `parentCategoryId`).
-* **Child Categories:** A category can have multiple child `Category` entities creating a hierarchy.
-* **Products:** A category contains multiple `Product` entities (identified by `categoryId`).
+- **Parent Category:** Each category can have one parent `Category` (identified by `parentCategoryId`).
+- **Child Categories:** A category can have multiple child `Category` entities creating a hierarchy.
+- **Products:** A category contains multiple `Product` entities (identified by `categoryId`).
 
 ## Hierarchy Examples
 
@@ -118,9 +119,9 @@ Electronics (Level 0)
 
 ## Business Rules
 
-* Root categories have `parentCategoryId` as null and `level` as 0
-* Child categories must have a valid `parentCategoryId`
-* Category slugs must be unique across the entire catalog
-* Categories cannot be deleted if they contain products or subcategories
-* Inactive categories should hide all associated products from public view
-* Maximum hierarchy depth should be limited (e.g., 5 levels)
+- Root categories have `parentCategoryId` as null and `level` as 0
+- Child categories must have a valid `parentCategoryId`
+- Category slugs must be unique across the entire catalog
+- Categories cannot be deleted if they contain products or subcategories
+- Inactive categories should hide all associated products from public view
+- Maximum hierarchy depth should be limited (e.g., 5 levels)

package/templates/default/domains/ProductCatalog/entities/Inventory/index.mdx

@@ -89,30 +89,31 @@ properties:
 The Inventory entity manages stock levels and availability for products in the e-commerce system. It tracks current quantities, reserved stock, and provides reorder management capabilities.
 
 ### Entity Properties
+
 <EntityPropertiesTable />
 
 ## Relationships
 
-* **Product:** Each inventory record belongs to one `Product` (identified by `productId`).
-* **OrderItem:** Inventory quantities are affected by `OrderItem` entities when orders are placed.
+- **Product:** Each inventory record belongs to one `Product` (identified by `productId`).
+- **OrderItem:** Inventory quantities are affected by `OrderItem` entities when orders are placed.
 
 ## Stock Calculations
 
-* **Available Quantity** = Quantity On Hand - Quantity Reserved
-* **Reorder Needed** = Quantity Available &lt;= Reorder Point
-* **Stock Value** = Quantity On Hand × Unit Cost
+- **Available Quantity** = Quantity On Hand - Quantity Reserved
+- **Reorder Needed** = Quantity Available &lt;= Reorder Point
+- **Stock Value** = Quantity On Hand × Unit Cost
 
 ## Examples
 
-* **Inventory #1:** iPhone 15 Pro - 25 on hand, 5 reserved, 20 available, reorder at 10 units.
-* **Inventory #2:** Running Shoes Size 9 - 0 on hand, 2 reserved, backorder allowed.
+- **Inventory #1:** iPhone 15 Pro - 25 on hand, 5 reserved, 20 available, reorder at 10 units.
+- **Inventory #2:** Running Shoes Size 9 - 0 on hand, 2 reserved, backorder allowed.
 
 ## Business Rules
 
-* Quantity on hand cannot be negative
-* Quantity reserved cannot exceed quantity on hand
-* Available quantity is automatically calculated
-* Reorder alerts are triggered when available = reorder point
-* Stock reservations are created when orders are placed
-* Stock is decremented when orders are shipped
-* Inventory adjustments must be logged for audit trail
+- Quantity on hand cannot be negative
+- Quantity reserved cannot exceed quantity on hand
+- Available quantity is automatically calculated
+- Reorder alerts are triggered when available = reorder point
+- Stock reservations are created when orders are placed
+- Stock is decremented when orders are shipped
+- Inventory adjustments must be logged for audit trail

package/templates/default/domains/ProductCatalog/entities/Product/index.mdx

@@ -95,23 +95,24 @@ properties:
 The Product entity represents items or services available for purchase in the e-commerce system. It serves as an aggregate root containing all product-related information including pricing, categorization, inventory details, and customer reviews.
 
 ### Entity Properties
+
 <EntityPropertiesTable />
 
 ## Relationships
 
-* **Category:** Each product belongs to one `Category` (identified by `categoryId`).
-* **Inventory:** Each product has one `Inventory` record tracking stock levels.
-* **Review:** A product can have multiple `Review` entities from customers.
-* **OrderItem:** Products are referenced in `OrderItem` entities when included in orders.
+- **Category:** Each product belongs to one `Category` (identified by `categoryId`).
+- **Inventory:** Each product has one `Inventory` record tracking stock levels.
+- **Review:** A product can have multiple `Review` entities from customers.
+- **OrderItem:** Products are referenced in `OrderItem` entities when included in orders.
 
 ## Examples
 
-* **Product #1:** "iPhone 15 Pro" - Electronics category, $999.99, with 50 units in stock and 4.5-star reviews.
-* **Product #2:** "Running Shoes" - Sports category, $129.99, various sizes available, with detailed size chart.
+- **Product #1:** "iPhone 15 Pro" - Electronics category, $999.99, with 50 units in stock and 4.5-star reviews.
+- **Product #2:** "Running Shoes" - Sports category, $129.99, various sizes available, with detailed size chart.
 
 ## Business Rules
 
-* Products must have a unique SKU across the entire catalog
-* Products cannot be deleted if they have associated order items
-* Price changes should be tracked for audit purposes
-* Products must belong to an active category to be purchasable
+- Products must have a unique SKU across the entire catalog
+- Products cannot be deleted if they have associated order items
+- Price changes should be tracked for audit purposes
+- Products must belong to an active category to be purchasable

package/templates/default/domains/ProductCatalog/entities/Review/index.mdx

@@ -122,13 +122,14 @@ properties:
 The Review entity captures customer feedback and ratings for products. It supports verified purchase validation, content moderation, community voting, and merchant responses to build trust and provide valuable product insights.
 
 ### Entity Properties
+
 <EntityPropertiesTable />
 
 ## Relationships
 
-* **Product:** Each review belongs to one `Product` (identified by `productId`).
-* **Customer:** Each review is written by one `Customer` (identified by `customerId`).
-* **Order:** Each review can be linked to one `Order` for purchase verification (identified by `orderId`).
+- **Product:** Each review belongs to one `Product` (identified by `productId`).
+- **Customer:** Each review is written by one `Customer` (identified by `customerId`).
+- **Order:** Each review can be linked to one `Order` for purchase verification (identified by `orderId`).
 
 ## Review Lifecycle
 
@@ -140,17 +141,17 @@ submitted → pending → approved → published
 
 ## Examples
 
-* **Review #1:** 5-star review for iPhone 15 Pro, verified purchase, "Excellent camera quality!"
-* **Review #2:** 3-star review for Running Shoes, helpful votes: 15/20, includes photos
-* **Review #3:** 1-star review flagged for inappropriate content, pending moderation
+- **Review #1:** 5-star review for iPhone 15 Pro, verified purchase, "Excellent camera quality!"
+- **Review #2:** 3-star review for Running Shoes, helpful votes: 15/20, includes photos
+- **Review #3:** 1-star review flagged for inappropriate content, pending moderation
 
 ## Business Rules
 
-* Reviews can only be submitted by customers who purchased the product
-* Rating must be between 1-5 stars
-* Verified purchase reviews are given higher weight in calculations
-* Inappropriate content is flagged and requires moderation
-* Customers can only review the same product once per purchase
-* Helpful votes help surface most valuable reviews
-* Merchant responses are limited to one per review
-* Reviews older than 2 years may have reduced weight in calculations
+- Reviews can only be submitted by customers who purchased the product
+- Rating must be between 1-5 stars
+- Verified purchase reviews are given higher weight in calculations
+- Inappropriate content is flagged and requires moderation
+- Customers can only review the same product once per purchase
+- Helpful votes help surface most valuable reviews
+- Merchant responses are limited to one per review
+- Reviews older than 2 years may have reduced weight in calculations

package/templates/default/domains/ProductCatalog/index.mdx

@@ -28,29 +28,31 @@ A visualization of the entities in the Product Catalog domain. Here you can see
 
 <EntityMap id="ProductCatalog" />
 
-
-
 ## Core Responsibilities
 
 ### Product Management
+
 - Maintain product information including pricing, descriptions, and specifications
 - Support product variants (size, color, style)
 - Handle product lifecycle (active, discontinued, draft)
 - Manage product relationships and cross-selling
 
-### Category Management  
+### Category Management
+
 - Organize products into hierarchical categories
 - Support multi-level category structures
 - Maintain category metadata and SEO information
 - Handle category navigation and filtering
 
 ### Inventory Management
+
 - Track stock levels and availability
-- Manage reorder points and stock alerts  
+- Manage reorder points and stock alerts
 - Handle inventory reservations and allocations
 - Support warehouse and location management
 
 ### Review Management
+
 - Collect and manage customer product reviews
 - Calculate review metrics and ratings
 - Moderate review content
@@ -60,7 +62,7 @@ A visualization of the entities in the Product Catalog domain. Here you can see
 
 - **Product**: Central aggregate containing all product information
 - **Category**: Hierarchical product categorization system
-- **Inventory**: Stock tracking and availability management  
+- **Inventory**: Stock tracking and availability management
 - **Review**: Customer feedback and rating system
 
 ## Business Rules
@@ -68,4 +70,4 @@ A visualization of the entities in the Product Catalog domain. Here you can see
 - Products must belong to an active category
 - Inventory levels affect product availability
 - Reviews require verified purchases
-- Category hierarchies have maximum depth limits
+- Category hierarchies have maximum depth limits

package/templates/default/domains/ProductCatalog/ubiquitous-language.mdx

@@ -2,7 +2,7 @@
 dictionary:
   - id: Product
     name: Product
-    summary: "A distinct item available for sale, defined by its attributes, pricing, and descriptions."
+    summary: 'A distinct item available for sale, defined by its attributes, pricing, and descriptions.'
     description: |
       A product is the central aggregate in the Product Catalog domain. It contains all information needed to present and sell an item:
 
@@ -15,7 +15,7 @@ dictionary:
     icon: Package
   - id: Category
     name: Category
-    summary: "A hierarchical grouping used to organize products for browsing and discovery."
+    summary: 'A hierarchical grouping used to organize products for browsing and discovery.'
     description: |
       Categories form a tree structure that helps customers navigate the catalog. Key aspects include:
 
@@ -28,7 +28,7 @@ dictionary:
     icon: FolderTree
   - id: Inventory
     name: Inventory
-    summary: "The tracked quantity of a product available for sale across warehouses and locations."
+    summary: 'The tracked quantity of a product available for sale across warehouses and locations.'
     description: |
       Inventory represents the stock levels for each product or variant. It involves:
 
@@ -41,7 +41,7 @@ dictionary:
     icon: Warehouse
   - id: Review
     name: Review
-    summary: "Customer feedback on a product, including a rating and optional written commentary."
+    summary: 'Customer feedback on a product, including a rating and optional written commentary.'
     description: |
       Reviews provide social proof and help customers make purchase decisions. Review management includes:
 
@@ -54,11 +54,11 @@ dictionary:
     icon: Star
   - id: SKU
     name: SKU
-    summary: "Stock Keeping Unit — a unique identifier assigned to each distinct product variant for inventory tracking."
+    summary: 'Stock Keeping Unit — a unique identifier assigned to each distinct product variant for inventory tracking.'
     icon: Tag
   - id: Variant
     name: Variant
-    summary: "A specific version of a product differentiated by attributes such as size, color, or material."
+    summary: 'A specific version of a product differentiated by attributes such as size, color, or material.'
     description: |
       Variants allow a single product to be offered in multiple configurations. Each variant has:
 
@@ -71,18 +71,18 @@ dictionary:
     icon: Layers
   - id: Pricing
     name: Pricing
-    summary: "The monetary value assigned to a product or variant, including base price, sale price, and currency."
+    summary: 'The monetary value assigned to a product or variant, including base price, sale price, and currency.'
     icon: DollarSign
   - id: Product Lifecycle
     name: Product Lifecycle
-    summary: "The stages a product moves through from creation to retirement: draft, active, and discontinued."
+    summary: 'The stages a product moves through from creation to retirement: draft, active, and discontinued.'
     icon: RefreshCw
   - id: Attribute
     name: Attribute
-    summary: "A descriptive property of a product such as weight, dimensions, material, or brand."
+    summary: 'A descriptive property of a product such as weight, dimensions, material, or brand.'
     icon: ListChecks
   - id: Cross-Sell
     name: Cross-Sell
-    summary: "A recommendation of related or complementary products to encourage additional purchases."
+    summary: 'A recommendation of related or complementary products to encourage additional purchases.'
     icon: ArrowRightLeft
 ---

package/templates/default/domains/Subscriptions/entities/BillingProfile/index.mdx

@@ -54,17 +54,18 @@ properties:
 The BillingProfile entity consolidates billing-specific details for a customer, such as the billing address, contact email for invoices, tax information, and potentially preferred payment methods. This might be distinct from the customer's general contact information or shipping addresses.
 
 ### Entity Properties
+
 <EntityPropertiesTable />
 
 ## Relationships
 
-*   **Customer:** A billing profile belongs to one `Customer`. A customer might potentially have multiple profiles in complex scenarios, but often just one.
-*   **Address:** Linked to a primary billing `Address`.
-*   **PaymentMethod:** May specify a preferred `PaymentMethod`.
-*   **Invoice:** Invoices are typically generated using information from the BillingProfile.
-*   **Subscription:** Subscriptions may use the associated customer's BillingProfile for charging.
+- **Customer:** A billing profile belongs to one `Customer`. A customer might potentially have multiple profiles in complex scenarios, but often just one.
+- **Address:** Linked to a primary billing `Address`.
+- **PaymentMethod:** May specify a preferred `PaymentMethod`.
+- **Invoice:** Invoices are typically generated using information from the BillingProfile.
+- **Subscription:** Subscriptions may use the associated customer's BillingProfile for charging.
 
 ## Examples
 
-*   Jane Doe's personal billing profile with her home address and primary email.
-*   Acme Corp's billing profile with their HQ address, VAT ID, and accounts payable email address. 
+- Jane Doe's personal billing profile with her home address and primary email.
+- Acme Corp's billing profile with their HQ address, VAT ID, and accounts payable email address.

package/templates/default/domains/Subscriptions/entities/SubscriptionPeriod/index.mdx

@@ -59,17 +59,18 @@ properties:
 The SubscriptionPeriod entity tracks the state and details of a specific billing cycle within a `Subscription`. It links the subscription to the relevant invoice and payment for that interval and records the exact dates and amount billed.
 
 ### Entity Properties
+
 <EntityPropertiesTable />
 
 ## Relationships
 
-*   **Subscription:** A subscription period belongs to one `Subscription`.
-*   **Plan:** Reflects the `Plan` active during this period.
-*   **Invoice:** May be associated with one `Invoice` generated for this period.
-*   **Payment:** May be associated with one `Payment` that settled the period's invoice.
+- **Subscription:** A subscription period belongs to one `Subscription`.
+- **Plan:** Reflects the `Plan` active during this period.
+- **Invoice:** May be associated with one `Invoice` generated for this period.
+- **Payment:** May be associated with one `Payment` that settled the period's invoice.
 
 ## Examples
 
-*   Period for Jane Doe's 'Pro Plan' from 2024-05-01 to 2024-05-31, invoiced via #INV-00123, status Paid.
-*   Period for Acme Corp's 'Enterprise Plan' from 2024-04-15 to 2024-05-14, status Billed, awaiting payment.
-*   The first period (trial) for a new subscription from 2024-05-20 to 2024-06-19, status Active, amountBilled $0.00. 
+- Period for Jane Doe's 'Pro Plan' from 2024-05-01 to 2024-05-31, invoiced via #INV-00123, status Paid.
+- Period for Acme Corp's 'Enterprise Plan' from 2024-04-15 to 2024-05-14, status Billed, awaiting payment.
+- The first period (trial) for a new subscription from 2024-05-20 to 2024-06-19, status Active, amountBilled $0.00.