@schematichq/schematic-components 2.18.0 → 2.20.0

package/README.md

@@ -59,6 +59,7 @@ const config = {
   payInAdvanceQuantities: {        // pre-fill pay-in-advance quantities, keyed by feature id (optional)
     feat_cns2asuKAG2: 3,           // "feat_cns2asuKAG2" is a feature id, 3 is the quantity
   },
+  promoCode: 'SUMMER20',           // pre-apply a Stripe promotion code (optional)
   skipped: {
     planStage: true,               // if true, skip Plan selection
     addOnStage: true,              // if true, skip Add-on selection
@@ -76,9 +77,41 @@ pricing; entries for other (or unknown) features are ignored. Combine it with
 `skipped.usageStage` / `skipped.addOnUsageStage` to send the customer straight to
 the final checkout step with the quantities already set.
 
+`promoCode` pre-applies a discount to the checkout. It expects a Stripe
+[promotion code](https://docs.stripe.com/billing/subscriptions/coupons) — the
+customer-facing code such as `SUMMER20`, not the underlying coupon id. The
+discount is applied on load, so the previewed charges reflect it and it ships
+with the final checkout request.
+
 The Plans and Add-ons available to the checkout flows must be live in your
 Schematic account [Catalog configuration](https://docs.schematichq.com/catalog/overview).
 
+## Programmatic Unsubscribe
+
+We provide a function `requestUnsubscribe` for starting the unsubscribe flow
+from your own UI, without using the built-in `UnsubscribeButton`. Like
+`initializeWithPlan`, it's suitable for click handlers and must be extracted
+from the library's embedded context.
+
+```ts
+const { requestUnsubscribe } = useEmbed();
+```
+
+This lets developers create their own button — for example, a custom
+"are you sure?" retention flow — that hands off to the same unsubscribe
+experience the built-in component uses.
+
+```ts
+requestUnsubscribe();
+```
+
+The function takes no arguments. If there is no active subscription to cancel,
+the request is ignored and a warning is logged to the console.
+
+The unsubscribe flow is rendered by the embed itself, so a Schematic embed (the
+`Viewport` that hosts it) must be mounted on the page where you call
+`requestUnsubscribe`. This is the same requirement as `initializeWithPlan`.
+
 ## License
 
 MIT