aljaz/BTCPayServerPlugins
1
0
Fork 0
mirror of https://github.com/aljazceru/BTCPayServerPlugins.git synced 2025-12-17 07:34:24 +01:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #52 from jacobburrell/patch-1

Browse Source 
Update README.md
This commit is contained in:
Andrew Camilleri
2024-09-20 15:26:39 +02:00
committed by GitHub
parent 66b48b50cf 63570fc708
commit 7f52d87aab
1 changed files with 3 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
Plugins/BTCPayServer.Plugins.Subscriptions/README.md
View File

@@ -4,7 +4,7 @@ This plugin allows you to create subscriptions in BTCPay Server.
Essentially you create an subscriptions app from the side navigation on your store, you configure a price, duration and description, and it will create a public page where your customers can subscribe to your service. Essentially you create an subscriptions app from the side navigation on your store, you configure a price, duration and description, and it will create a public page where your customers can subscribe to your service.
When they click on the subscribe button, a payment request is created. if Settled, a new subscription is created, and a button on the payment request page will appear leading them to their subscription page. When they click on the subscribe button, a payment request is created. If Settled, a new subscription is created, and a button on the payment request page will appear leading them to their subscription page.
You can configure the subscription to set a form to be filled by the customer on the first payment request created. It is recommended to set this and collect an email under the `buyerEmail` field, as this You can configure the subscription to set a form to be filled by the customer on the first payment request created. It is recommended to set this and collect an email under the `buyerEmail` field, as this
plugin provides new webhooks for subscription status changes and subscription renewal notices. plugin provides new webhooks for subscription status changes and subscription renewal notices.
@@ -13,7 +13,7 @@ Additionally there is one new Greenfield API endpoint: GET https://btcpay.host/a
If the subscription is about to expire (within 3 days), a payment request is created to extend the period of the subscription. This payment request expires when the subscription expires. if this happens, the subscription is marked as inactive If the subscription is about to expire (within 3 days), a payment request is created to extend the period of the subscription. This payment request expires when the subscription expires. if this happens, the subscription is marked as inactive
quick demo Quick demo:
https://streamable.com/y9gimo https://streamable.com/y9gimo
## Email rules: ## Email rules:
@@ -21,4 +21,4 @@ https://streamable.com/y9gimo
There are 2 new email rules: There are 2 new email rules:
* A subscription status has been updated: has placeholders:{Subscription.SubscriptionId},{Subscription.Status},{Subscription.AppId} * A subscription status has been updated: has placeholders:{Subscription.SubscriptionId},{Subscription.Status},{Subscription.AppId}
* "A subscription has generated a payment request for renewal: has placeholders: {Subscription.SubscriptionId}, {Subscription.PaymentRequestId},{Subscription.AppId} * "A subscription has generated a payment request for renewal: has placeholders: {Subscription.SubscriptionId}, {Subscription.PaymentRequestId},{Subscription.AppId}