Subscription Details Banner
The banner at the top of the Subscription Details page includes the following information about a recurring payment:
Subscription Details Banner Item | Description |
|---|
Customer | The name of the customer who pays the subscription charges. |
Payments Made | The number of previous payments made through the subscription and their dollar amount. |
Payments Remaining | The number of remaining payments for the subscription and their dollar amount. |
Payments Failed | The number of missed payments and their dollar amount. |
Plan Name | The name of the subscription. |
Plan Amount | The recurring cost in dollars for the subscription. |
Subscription Amount | The total dollar amount of the subscription. |
Merchant | The name of the merchant associated with the subscription. |
The lower half of the Subscription Details page contains the Subscription Information Box, which contains four tabs on the left-hand side of the box. The tabs consist of information related to aspects of the subscription, the customer, and the merchant. The following sections of this page cover descriptions of the contents of each of the four tabs:
Details Tab
The Details tab includes the following details for a specific subscription:
Details Tab Item Name | Description |
|---|
ID | The subscription identification number. |
Created | The date that the subscription was created. |
Plan ID | The plan identification number. |
Merchant ID | The merchant identification number. |
Start | The start date for the subscription. |
Finish | The date that the subscription will end. |
Tax | The dollar amount of tax charged with the subscription. |
Max. Consecutive Failures | The maximum number of attempts made to charge the saved payment method for the subscription if the payment method fails or is declined. If the Max. Consecutive Failures limit is reached, the subscription will be canceled. |
Consecutive Failures | Number of consecutive failed transactions. |
Status | The status of the subscription: Active or Inactive |
Transaction Description | Defined by the merchant, and applied to transactions generated as part of the subscription. |
Details Tab Actions
The Details tab supports the following actions: copy/paste, and edit.
Copy and paste information from select fields by clicking the COPY/PASTE icon.
To edit any fields on the Details tab, follow the steps below:
Step 1: Click the EDIT icon in the top right-hand corner of the box.
Step 2: Type your editing into the Details field.
Step 3: Click the Check Mark icon at the top right-hand corner to save or the X icon to revert to the previously saved details.
Tokens Tab
The Tokens tab displays a table of Payment Tokens associated with a subscription, as well as an option to add a new payment method. The Payment Tokens table includes the following information in the default view:
Payment Tokens Table Column Name | Description |
|---|
Token | The token identification number. |
Expiration | The expiration date for the token. |
Type | The type of credit card. |
Number | The credit card number associated with the token. |
Payment Token Tab Actions
The Payment Token tab supports the following actions: add a new payment token, and remove a token.
To add a new payment token, follow the steps below:
Click the ADD PAYMENT button in the top right-hand corner.
Add the token ID, or click CREATE WITH TOKEN to create a payment using customer email and credit card information.
Click ADD to save the new payment, or click CANCEL to return to the Token tab.
Remove a token from the table by clicking the TRASH CAN icon to remove the token from the subscription.
Plan Details Tab
The Plan Details tab contains the following information about the subscription:
Plan Details Tab Item Name | Description |
|---|
Plan ID | The plan identification number. |
Created | The date that the subscription was created. |
Merchant ID | The merchant identification number. |
Name | The merchant’s name for the subscription plan. |
Description | The type of plan. |
Amount | The scheduled subscription payment in dollars. |
Schedule Factor | The number of times per month that the subscription is billed. |
Schedule | Monthy, daily, or yearly schedule of payments. |
Status | The status of the subscription: Active or Inactive |
Transaction Description | A description that will be applied to transactions generated as part of the subscription. |
Plan Details Tab Actions
Copy and paste information from select fields by clicking the COPY/PASTE icon.
Transactions Tab
The Transactions tab contains a table that lists the individual transactions associated with the subscription payment plan. The table shows the following information in the default view:
Transactions Table Column Name | Description |
|---|
Amount | The amount in dollars charged for the recurring payment. |
Status | Indicates whether the transaction was captured as a recurring payment by the merchant. |
Cardholder | The name of the cardholder. |
Payment | The credit card brand and the last four digits of the card number. |
Created | The date and time that the transaction was created. |
Check boxes | Tick to select specific transactions, or tick the checkbox in the table header to select all transactions. |
Arrow Icon | Click on the grey triangle in any row to view additional details for a specific transaction, or click on the grey triangle in the table header to view additional details for all transactions. |
Transactions Tab Actions
The Transactions tab supports the following actions: access more information, and issue a refund.
Access specific Transaction Details by clicking any information in a row.
Issue Refunds on certain transactions using the Batch Actions function:
Step 1: Select specific transactions from the Transactions table using the Check boxes in the table column on the right-hand side.
Step 2: Navigate to the Batch Actions drop-down, select the grey triangle, and click REFUNDS.
Step 3: Confirm the refund request in the pop-up window, or cancel to go back to the Payments History page.
.png)
