This document uses mock data from Finix's sandbox environment. Some features and functions may be unavailable depending on your platform configuration.
The Subscription Billing feature allows Platforms to automatically charge their merchants on a fixed billing plan. For example, Platforms can charge a one-time registration fee or an annual software renewal fee with Subscription Billing.
Subscription Billing is available on the Dashboard. Subscription Billing can be found under the SYSTEM header on the Dashboard. The Subscription Billing homepage shows two pages, one for all Subscription Schedules and another for all Subscription Fees for the Platform.
Note: The Subscription Billing feature is also available via API. Actions completed via API will be reflected in the Dashboard.
You can also filter through Subscription Schedules by clicking on the filters button at the left of the screen. You can filter by Subscription Type or Schedule Nickname.
Subscription Schedule details page
From the Subscription Schedules page, you can create a Subscription Schedule. To create a Subscription Schedule, click the Create a Subscription Schedule button at the top right of the screen. Clicking the Create a Subscription Schedule button opens up a pop-up window that will create and apply a subscription to a merchant.
There are three steps to create a Subscription:
1. Create a Subscription Schedule. The Subscription Schedule details when the fee is charged to the merchant. The following fields are required:
- Schedule Nickname: The name of the Subscription Schedule. The nickname can be used for search and filtering purposes
- Subscription Type: The type of Subscription Schedule. There are three schedule types available. Each schedule type provides different functionality. Select the appropriate using the drop-down
-
-
The FIXED_TIME Subscription Schedule charges a Merchant on a fixed interval. The interval uses hourly increments.
-
-
-
- Interval (Hours): Hourly increments between recurring charges
- Interval Count: Number of recurring charges After selecting the Subscription Type and Interval, confirmation of the schedule appears at the bottom of the pop-up window.
2. A PERIODIC_MONTHLY Subscription Schedule charges a Merchant a Fee on a specific day every month.
-
-
- Period Offset (Day): Specifies the day when the Subscription Schedule starts
-
3. A PERIODIC_YEARLY Subscription Schedule charges a Merchant a Fee once a year on a specific day and month.
-
-
- Month: Specifies the month when the Subscription Schedule starts
- Day: Specifies the day when the Subscription Schedule starts
-
3. Click the Next button to move to the next screen.
2. Create a Subscription Amount. The Subscription Amount is the amount to be charged to a merchant. The following fields are required. Click the Next button to move to the next screen.
- Amount Nickname: Nickname for the Subscription Amount
- Amount: Subscription amount. There is no limit on the amount
- Label (Optional) : Description for the subscription amount
- Optional field: Tags
3. Confirm the Subscription. This confirmation screen displays the subscription details including type, amount, and other information. On this screen, you can edit the Subscription and or Amount information by clicking on the Edit button to the right of the modal. To save and create a subscription, click the Submit button.
4. A success message appears at the top of the screen confirming the Subscription Amount was created.
On the Subscription Schedule details page, the Subscription Amount details, such as period offset, created at date, and the amount will be displayed.
Managing Subscriptions
After creating a subscription, you can manage your subscription’s amounts on the subscription’s General Info header. This includes the following actions: Add an Amount, Edit an Amount and Delete an Amount. To complete an action, click the Manage Amounts button at the top right and select the appropriate action from the drop-down. Clicking on any of the actions opens a new pop-up window.
Note: Any change to the amounts in a subscription schedule will change the amounts for all merchants enrolled in that schedule.
Add an amount
-
-
- To add a new Subscription Amount to an existing schedule, complete the following fields:
- Amount Nickname: Nickname for the Subscription Amount
- Amount: Subscription amount. There is no limit on the amount
- Label (Optional) : Description for the subscription amount
- Optional field: Tags
- Click the Create button to create a new amount.
- A success message appears at the top of the screen confirming the Subscription Amount was created. On the subscription screen, the new fee will appear under the Amounts modal.
- To add a new Subscription Amount to an existing schedule, complete the following fields:
-
Edit an amount
-
-
- To edit an Amount associated with a subscription, complete the following fields:
- Subscription Amount: Name for the Subscription Amount. Select the appropriate amount from the drop-down
- Amount Nickname: Nickname for the Subscription Amount
- Amount: Subscription Amount. There is no limit on the amount
- Label (Optional) : Description for the Subscription Amount
- To edit an Amount associated with a subscription, complete the following fields:
-
-
-
- Click the Edit button to save the edited amount. A success message appears at the top of the screen confirming the Subscription Amount was edited.
- Any Edit to the amount will affect all the merchants who are currently enrolled in this subscription schedule. Any change here would change the amounts for all merchants who are on the schedule.
-
Delete an amount
- To delete an Amount associated with a subscription, select the appropriate amount from the drop-down. Click the Delete button to save your changes or the Cancel button to exit out of the screen.
- Any Delete to the amount will affect all the merchants who are currently enrolled in this subscription schedule. Any change here would change the amounts for all merchants who are on the schedule.
Viewing a Subscription’s Enrollments
A Subscription Enrollment details:
- Which schedule a merchant will be charged for
- For what period of time
You can view a subscription’s enrollments by clicking the SUBSCRIPTION ENROLLMENTS header on a subscription’s info page. This page displays a list of all enrollments belonging to this subscription, including information such as the merchant, enrollment information, and schedule information of each enrollment. Clicking on an enrollment also redirects to the related merchant’s General Info page.
Deleting Subscription Enrollments
To delete an enrollment:
- Select the enrollment(s) and check the box inline.
- Navigate to the drop-down at the bottom of the page. Select Delete Enrollments.
A pop-up modal appears asking you to confirm your actions. Click the Yes button to confirm or click the No button to cancel and close out of the modal.
Comments
0 comments
Please sign in to leave a comment.