๐ Subscriptions
The Coinflow ecosystem provides a way to bill your customers on a weekly / yearly interval. You define the subscription plan(s) and the subscribers will be charged accordingly.
Defining Plans
Plans are the backbone of subscriptions - they define how a subscription will work.
Plan Details
| Field | Required | Description |
|---|---|---|
| Name | Yes | The short description of the plan |
| Code | Yes | The unique identifier of the plan (no spaces) |
| Description | No | A explanation of the details of the plan |
| Interval | Yes | The frequency of billing (Monthly / Yearly) |
| Duration | No | The number of intervals the subscription will run until expiration. For example, if the frequency is monthly and the duration is 12, the subscription will expire after a year |
| Amount | Yes | The base amount ot be billed every interval |
| Transaction | No | Solana Only - the on-chain transaction to be used for the payments |
Managing Plans
Once a plan is created, you can see the subscribers, edit the details, and deactivate it
Subscribers
When you click on one of the plans, you will see all of the subscribers listed for that plan. You can quickly see the payments made for the subscription or cancel the subscription.
Subscriptions can be in the following states:
| Status | Description |
|---|---|
| Active | The subscription is in good standing |
| Canceled | The subscription was canceled by the merchant or customer |
| Expired | The underlying plan is not longer available |
| Concluded | The duration of the plan has reached the end |
| Failed | A recurring payment failed (suspending the subscription) |
| Blocked | The customer has been blocked in our ecosystem (suspending the subscription) |
Updated 2 months ago