This topic describes the following pages:
Subscription Details
Payment Token
The Subscription Details page contains information about any recurring payment made as part of a subscription. Subscription Details can be accessed for transactions listed on your Recurring Payments table.
To access the Subscription Details page:
Access the Recurring Payments page under the Payments category in the left navigation panel.
Click any information in a Recurring Payments table row to open the Subscription Details page for that recurring payment.
Subscription Details Features
Click here to view the features of the Subscription Details page.
Subscription Details Banner
The banner at the top of the Subscription Details page includes the following information about a recurring payment:
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.
Subscription Information Box
The lower half of the Subscription Details page contains the Subscription Information Box, which contains four tabs on the left 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:
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 copying and pasting information and editing fields.
Copy and paste information from select fields by clicking the COPY/PASTE icon.
To edit any fields on the Details tab:
Click the EDIT icon in the top right corner of the box.
Type your editing into the Details field.
Click the Check Mark icon at the top right 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:
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 adding a new payment token and removing a token.
To add a new payment token:
Click the ADD PAYMENT button in the top right 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.
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 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: Monthly, 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:
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.
Checkboxes: Tick to select specific transactions, or tick the checkbox in the table header to select all transactions.
Arrow Icon: Click the grey triangle in any row to view additional details for a specific transaction, or click the grey triangle in the table header to view additional details for all transactions.
Transactions Tab Actions
The Transactions tab supports accessing more information and issuing a refund.
Access specific Transaction Details by clicking any information in a row.
To issue refunds on certain transactions using the Batch Actions function:
Select specific transactions from the Transactions table using the Checkboxes in the table column on the right side.
Access the Batch Actions dropdown menu, select the grey triangle, and click REFUNDS.
Confirm the refund request in the pop-up window.
Customize Your Subscription Transaction Table
You can customize your view using the options found at the top of the table on the Subscription Transactions tab. View the Table Search and Sort Instructions for instructions on customizing, sorting, or searching tables.
Expand the section below to view a complete list of the data that you can display on the Subscription Transactions Tab Table, found in the Subscription Details Box:
Click here to view the Subscription Transaction Tab columns.
Transaction Data
Amount
Cardholder
Payment
Created
TXN ID
Zip
Currency
Company
Created by
Date Modified
Modifier
Subscription Type
Captured
Description
Order
Tax
Approved
Refunded
Terminal ID
Channel
First Name
Last Name
Address
City
State
Country
Phone
Email
Entity Data
Merchant
Entity
Custom
Entity ID
Parameters ID
Entity Type
Address
Entity City
Entity State
Entity Zip
Entity Country
Entity Phone
Entity Fax
Entity Email
Entity Website
EIN
Entity Currency
Entity Status
Division Data
Division Name
User Data
Login ID
Merchant Data
Merchant ID
Merchant Dba
Merchant MCC
Merchant Created
Merchant Created By
Merchant Date Modified
Merchant Modified By
Merchant Boarded
Merchant Last Txn
Merchant Date Established
Merchant Status
Payment Token
The Payment Token page allows users to view and edit information associated with a payment token linked to a subscription. A payment token is the cryptographically generated representation of a payment method that can be safely stored and used to process future transactions.
To access the Payment Token page:
Access the Recurring Payments page under Payments in the left navigation panel.
Click any information in a Recurring Payments table row to redirect to the Subscription Details page.
Click the Tokens Tab located in the Subscription Information box, in the lower half of the Subscription Details page.
Click any information in the Tokens table to access the Payment Token page.
Payment Token Features
Click here to view the features of the Payment Token page.
The Payment Token page contains an editable form that includes the following information about a payment token:
ID: The identification number assigned to the token.
Expiration: The credit card expiration date.
Type: The type of credit card used during the transaction.
Number: The credit card number, with the last four digits visible.
Name: The name on the credit card.
Description: The description associated with the token.
Custom Description: A custom description written by the merchant.
Token: The tokenized identification number associated with the credit card.
Payment Token Actions
To edit information on the Payment Token page:
Click the EDIT icon in the upper right corner.
Enter information into the editable fields.
Save your edited information by clicking the CHECK MARK icon in the upper right corner, or discard changes and return to the Payment Token page by clicking the X icon.