Manage Subscriptions

You can manage subscriptions in
Manage Subscriptions
 and
Token Management
.

Figure:

Subscription Flow
A subscription has one of these statuses:
Created
The subscription has been created but the first payment has not been processed.
Pending
The first payment is scheduled or the subscription is in transition to another state.
Active
The subscription is currently in use. It is set with a payment instrument and a payment is scheduled at a pre-determined frequency agreed upon with your customer.
Delinquent
A scheduled payment was declined.
The system automatically retries the payment for a number of times. If the payment succeeds, the system automatically moves the subscription back to
active
 state. Otherwise, if the automated retry logic fails to obtain a successful payment, the system automatically moves the subscription to the
suspended
 state.
Suspended
The automated retry logic failed to obtain successful payment, or you have explicitly suspended the subscription. In order to resume a suspended subscription for the next billing cycle, choose one of these options:
  • Collect a different payment method from your customer and then reactivate the subscription
  • Cancel the subscription and create a new subscription for your customer.
Cancelled
You have explicitly cancelled the subscription and it cannot be reactivated. You might cancel an active or pending subscription when you and the customer agree to end the subscription. You might choose to cancel a delinquent subscription rather than wait for the automatic retry logic to proceed. You might cancel a suspended subscription if the customer does not have an acceptable alternate payment method.
IMPORTANT
You cannot cancel a subscription within 10 minutes before or after a payment begins processing.
Completed
All scheduled payments were made. This is the state of a subscription that ends with all scheduled payments successfully completed. This state applies to subscriptions set up with a scheduled end date.
IMPORTANT
You cannot reactivate a completed subscription.
IMPORTANT
For information about managing subscriptions from the
Token Management
 area in the
Business Center
, see Manage Subscriptions in Token Management.

Manage Subscriptions in
Manage Subscriptions

When you manage subscriptions from the
Manage Subscriptions
 area in the
Business Center
, you can search for them using these filters:
  • Subscription code
  • First name
  • Last name
  • Plan name
  • Subscription status

Creating a Subscription

Create subscriptions with an existing plan. Only plans with an
ACTIVE
 status can be attached to a subscription.
You can add a differential fee to a subscription using the
Surcharge Amount
 and
Surcharge Description
 fields when you create a subscription. The surcharge amount is added to the billing amount when the recurring payment is processed. Before including a surcharge in your subscription, refer to your local regulations for compliance on surcharging customers, and confirm that your processor supports surcharges.
  1. Log in to the
    Business Center
    .
  2. On the left navigation panel, click
    Token Management
    .
  3. Click
    Tokens
    . The Token List page appears.
  4. Click the token ID for which you want to create a subscription.
  5. Click
    Create Subscription
    . The Create Subscription page appears.
  6. Under Subscription Information, enter this information:

    ADDITIONAL INFORMATION

    • Subscription code: generated by the Recurring Billing service (default) or assigned by the merchant.
    • Subscription name
    • Start date (Payment processing time starts at 2:00a.m. in your time zone.)
  7. Under Plan Options, select an existing active plan or
    New One Time Plan
    .

    ADDITIONAL INFORMATION

    The customer's payment and billing information appear.
  8. Under Billing Details, enter or edit this information:

    ADDITIONAL INFORMATION

    • Billing amount
    • Currency
    • Billing period length
    • Billing period unit
    • Set-up fee (optional)
    IMPORTANT
    A subscription's plan duration (billing cycles) cannot exceed 12 months.
  9. Edit or enter the billing cycle by choosing one of these options:

    ADDITIONAL INFORMATION

    • Bill indefinitely.
    • Define billing period end and enter the plan period length. The plan period unit defaults to the same length as the billing period length.
  10. Under Differential Fee, enter this information:

    ADDITIONAL INFORMATION

    • Surcharge amount
    • Surcharge description
  11. Click
    Submit
    . The Token Management Customer Details page appears.
  12. Click the
    Subscriptions
     tab and view the new subscription in the subscriptions list.

Creating a Subscription with an Existing Customer Token

Create a subscription with an existing plan and an existing customer token. Only plans with an
ACTIVE
 status can be attached to a subscription.
  1. Log in to the
    Business Center
    .
  2. On the left navigation panel, click
    Manage Subscriptions
    .
  3. Click
    Manage Subscriptions
    . The Manage Subscriptions page appears.
  4. Click
    Create Subscription
    .
  5. Select
    Existing Customer
    . The Create Subscription page appears.
  6. Enter the customer first and last name, the click
    Search
    .
  7. Find the customer and click
    Select
    . The payment and shipping address details are pre-populated. The Subscription Details panel appears.
  8. Enter these subscription details:

    ADDITIONAL INFORMATION

    • Subscription name
    • Start date (Payment processing time starts at 2:00a.m. in your time zone.)
    • Subscription code
  9. Select a subscription billing plan and then click
    Apply
    . The billing details appear.
  10. Click
    Change
     to edit these billing details:

    ADDITIONAL INFORMATION

    • Billing amount
    • Billing cycles
    • Set-up fee
  11. Click
    Create Now
     and then click
    Yes, create
     to create the new subscription with the new customer token.
  12. Click the
    Subscriptions
     tab and view the new subscription in the subscriptions list.

Creating a Subscription with a New Customer Token

Create a subscription with a new customer token. Only plans with an
ACTIVE
 status can be attached to a subscription.
  1. Log in to the
    Business Center
    .
  2. On the left navigation panel, click
    Manage Subscriptions
    .
  3. Click
    Manage Subscriptions
    . The Manage Subscriptions page appears.
  4. Click
    Create Subscription
    .
  5. Select
    New Customer
    , then click
    Continue
    . The Create Subscription page appears.
  6. Enter customer details.
  7. Add merchant-defined data fields, if applicable.
  8. Click
    Continue
    . The Payment Details panel appears.
  9. Select the payment method, then click
    Apply
    .
  10. Enter these card details:

    ADDITIONAL INFORMATION

    • Card type
    • Card number
    • Expiration date
    • Currency
  11. Enter these billing address details:

    ADDITIONAL INFORMATION

    • First name
    • Last name
    • Company (optional)
    • Country
    • Address
    • Apartment, suite, floor, building, etc. (optional)
    • City
    • State/province
    • Postal code
    • Email
    • Phone (optional)
  12. Click
    Continue
    . The Shipping Address Details panel appears.
  13. Click
    Yes
     to edit shipping address details.
  14. Click
    Continue
    .
  15. Enter these subscription details:

    ADDITIONAL INFORMATION

    • Subscription name
    • Start date (Payment processing time starts at 2:00a.m. in your time zone.)
    • Subscription code
  16. Select a subscription billing plan,then click
    Apply
    . The billing details appear.
  17. Click
    Change
     to edit these billing details:

    ADDITIONAL INFORMATION

    • Billing amount
    • Billing cycles
    • Set-up fee
  18. Click
    Create Now
    , then click
    Yes, create
     to create the new subscription with the new customer token.
  19. Click the
    Subscriptions
     tab and view the new subscription in the subscriptions list.

Viewing a Subscription in Recurring Billing

You can view subscription details, including payment history and the next scheduled payment. Use these filters to search for subscriptions:
  • Subscription code
  • First name
  • Last name
  • Plan name
  • Subscription status
Follow these steps to view a subscription in Recurring Billing:
  1. Log in to the
    Business Center
    .
  2. On the left navigation panel, click
    Recurring Billing
    .
  3. Click
    Manage Subscriptions
    . The Manage Subscriptions page appears.
  4. To search for subscriptions, click
    Add a Filter
    , and select one of the filter options.
  5. Enter the exact information, and press
    Enter
    . Matching search results display in the list.
  6. To view the details for a subscription, click the subscription code. The Subscription Details page appears.

Editing a Subscription in Recurring Billing

You can add a differential fee to a subscription using the
Surcharge Amount
 and
Surcharge Description
 fields when you create a subscription. The surcharge amount is added to the billing amount when the recurring payment is processed. Before including a surcharge in your subscription, refer to your local regulations for compliance on surcharging customers, and confirm that your processor supports surcharges.
Information you can edit:
  • Subscription code
  • Subscription name
  • Plan option
  • Billing amount
Follow these steps to edit a subscription in Recurring Billing:
  1. Log in to the
    Business Center
    .
  2. On the left navigation panel, click
    Recurring Billing
    .
  3. Click
    Manage Subscriptions
    . The Manage Subscription page appears.
  4. Find the subscription and click the subscription code. The Subscription Details page appears.
  5. Click
    Edit
    . The Edit Subscription page appears.
  6. To change the status of the subscription, click
    Suspend Subscription
     or
    Cancel Subscription
    .
  7. To edit the subscription, click
    Edit
    .
  8. Make changes.
  9. Click
    Update
    . The Subscription Details page appears.