docs: Update software updates API documentation for structured changelogs

This commit is contained in:
Dwindi Ramadhana
2026-06-03 21:24:24 +07:00
parent 3bd4b12a51
commit 80b0da7b22
4 changed files with 64 additions and 17 deletions

View File

@@ -11,32 +11,38 @@ To use Subscriptions, ensure:
2. Your payment gateway supports tokenization / recurring payments (e.g., Stripe, PayPal).
## Creating a Subscription Product
1. Go to **Products > Add New** in WordPress.
2. In the Product Data dropdown, select **Simple Subscription** or **Variable Subscription**.
WooNooW implements subscriptions directly within the standard product settings, eliminating the need for separate product types.
1. Go to **Products** in the Admin SPA and create or edit a product.
2. In the **General** tab, scroll down and check **Enable subscription for this product**.
3. Configure the billing schedule:
- **Subscription Price:** The recurring amount (e.g., $15).
- **Billing Interval/Period:** How often they are charged (e.g., every 1 month).
- **Expire After:** When the subscription automatically ends (leave empty for "Never expire").
- **Sign-up Fee:** Optional one-time fee added to the first payment.
- **Free Trial:** Offer an initial period at no cost (e.g., 14 days).
4. Publish the product.
- **Period & Interval:** How often they are charged (e.g., every 1 month).
- **Trial Days:** Offer an initial period at no cost (e.g., 14 days).
- **Signup Fee:** Optional one-time fee added to the first payment.
> [!NOTE]
> For variable products, you can configure these subscription settings at the variation level in the **Variations** tab, allowing different billing terms for different variations.
## Managing Subscriptions (Admin)
Store owners can view and manage all active, paused, or cancelled subscriptions directly from the Admin SPA.
1. Navigate to **Store > Subscriptions**.
2. Click on any Subscription ID to view details.
3. From the detail view, you can:
- **Pause** an active subscription.
- **Pause/Resume** an active subscription.
- **Cancel** a subscription.
- **Change Next Payment Date**.
- **Process Renewal** manually.
- **Renew Now**: Initiates a standard renewal process.
- **Charge Now**: Bypasses gateway capability checks to attempt an immediate auto-debit charge. If it fails, the order is marked as failed without falling back to a manual payment link.
## Customer Experience
When a customer purchases a subscription, they gain access to a self-service dashboard in their account:
1. Customers navigate to **My Account > Subscriptions**.
2. They can view the status, next payment date, and associated orders.
3. They have full autonomy to actions like **Pause**, **Resume**, or **Cancel** their own subscriptions based on the permissions you configure in the module settings.
4. If a payment fails, customers will see a clear **Pay Now** button to update their billing details.
3. They have autonomy to take actions like **Pause**, **Resume**, or **Cancel** their own subscriptions.
- **Pause Limits:** If configured in settings, customers are restricted to a maximum number of pauses (e.g., max 3 pauses per subscription). The UI clearly displays how many pauses are remaining.
4. **Early Renewals:** Customers can choose to renew early. When paying for an early renewal, the UI clearly displays the projected next billing date so they know exactly when their subsequent charge will occur.
5. If a payment fails, customers will see a clear **Pay Now** button to update their billing details.
## Automated Emails
The notification system automatically handles subscription lifecycle events: