Skip to main content

Manage Subscriptions


You can manage subscriptions in the Manage Subscriptions and Token Management areas of the .

Subscription Flow

A subscription always has one of these statuses:

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 that you agreed upon with your customer.

Delinquent

When a scheduled recurring payment fails, the account is placed in a Delinquent status while the system retries the payment multiple times. If the retries all fail, the account is placed into a Suspended status.

Suspended

The automated retry logic failed to obtain successful payment, or you have explicitly suspended the subscription. 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.

Completed

All scheduled payments were made. This is the state of a subscription that ends with all scheduled payments completed. This state applies to subscriptions set up with a scheduled end date.

Prerequisites

Log in to the for your environment before completing any of the tasks on this page:

Log in to the .

Search for Subscriptions

When you manage subscriptions from the Manage Subscriptions area in the , you can search for them using these filters:

  • Subscription code
  • First name
  • Last name
  • Plan name
  • Subscription status

Create a Subscription

You can create a subscription with an existing plan, an existing customer token, a new customer token, or from an existing transaction.

You can add a differential fee 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.

Follow these steps to create a subscription with an existing plan:

  1. On the left navigation panel, click Token Management. The Token Management page appears.
  2. Click Token List. The Token List page appears.
  3. Click the token ID for which you want to create a subscription.
  4. Click Create Subscription. The Create Subscription page appears.
  5. Under Subscription Information, enter this 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:00 a.m. in your time zone.)
  6. Under Plan Options, choose an existing active plan or New One Time Plan. The customer's payment and billing information appear.
  7. Under Billing Details, enter or edit this information:
    • Billing amount
    • Currency
    • Billing period length
    • Billing period unit
    • Set-up fee (optional)
  8. Edit or enter the billing cycle by choosing one of these options:
    • 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.
  9. Click Submit. The Token Management Customer Details page appears.
  10. Click the Subscriptions tab, and view the new subscription in the subscriptions list.

Before clicking Submit, optionally enter a differential fee under Differential Fee by entering the surcharge amount and surcharge description.

Create a Subscription with an Existing Customer Token

Follow these steps to create a subscription with an existing plan and an existing customer token:

  1. On the left navigation panel, choose Recurring Billing > Manage Subscriptions.
  2. Click Create Subscription.
  3. Select Existing Customer. The Create Subscription page appears.
  4. Enter the customer first and last name, and then click Search.
  5. Find the customer in the results and click Select. The payment and shipping address details are pre-populated. The Subscription Details panel appears.
  6. Enter these subscription details:
    • Subscription name
    • Start date (payment processing time starts at 2:00 a.m. in your time zone.)
    • Subscription code
    • (Optional) Merchant Reference Number: the value that you enter is used as the Merchant Reference Number for all subscription payments. If no value is provided, Recurring Billing automatically generates a random number for each subsequent payment.
  7. Select a subscription billing plan, and then click Apply. The billing details appear.
  8. (Optional) Click Change to edit these billing details:
    • Billing amount
    • Billing cycles
    • Set-up fee
  9. Click Create Now, and then click Yes, create to create the new subscription with the existing customer token.
  10. Click the Subscriptions tab and view the new subscription in the subscriptions list.

Create 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.

Follow these steps to create a subscription with a new customer token:

  1. On the left navigation panel, choose Recurring Billing > Manage Subscriptions.
  2. Click Create Subscription.
  3. Choose New Customer, and then click Continue. The Create Subscription page appears.
  4. Enter customer details.
  5. Add merchant-defined data fields, if necessary.
  6. Click Continue. The Payment Details panel appears.
  7. Choose the payment method, and then click Apply.
  8. Enter these card details:
    • Card type
    • Card number
    • Expiration date
    • Currency
  9. Enter these billing address details:
    • First name
    • Last name
    • Company (optional)
    • Country
    • Address
    • Apartment, suite, floor, building, or building number (optional)
    • City
    • State/province
    • Postal code
    • Email
    • Phone (optional)
  10. Click Continue. The Shipping Address Details panel appears.
  11. Click Yes to edit shipping address details.
  12. Click Continue.
  13. Enter these subscription details:
    • Subscription name
    • Start date (payment processing time starts at 2:00 a.m. in your time zone.)
    • Subscription code
    • (Optional) Merchant Reference Number: the value that you enter is used as the Merchant Reference Number for all subscription payments. If no value is provided, Recurring Billing automatically generates a random number for each subsequent payment.
  14. Choose a subscription billing plan, and then click Apply. The billing details appear.
  15. Click Change to edit these billing details:
    • Billing amount
    • Billing cycles
    • Set-up fee
  16. Click Create Now, and then click Yes, create to create the new subscription with the new customer token.
  17. Click the Subscriptions tab, and view the new subscription in the subscriptions list.

Create a Follow-On Subscription from an Existing Transaction

This method eliminates the need to create a new customer token or search for an existing one.

You can use an existing plan that has ACTIVE status or you can use a one-time plan to set up the subscription.

You can add a differential fee to a subscription using the surcharge amount and surcharge description fields when you create a subscription. You add the surcharge amount to the billing amount when you process the recurring payment.

Follow these steps to create a follow-on subscription from an existing transaction:

  1. On the left navigation panel, click Transaction Management.
  2. Click Transactions. The Transactions List page appears.
  3. Search for a successful transaction from the past using filters.
  4. Click the request ID of a transaction from which you want to create a subscription. The Transaction Details page appears.
  5. Click Actions and then select Create Subscription. The Create Subscription page appears. The Actions button appears only when the transaction is successful. The customer, payment, and shipping address details are pre-populated from the transaction data.
  6. Under Subscription Details, enter this information:
    • Subscription name
    • Start date (payment processing time starts at 2:00 a.m. in your time zone)
    • Subscription code (generated by the default Recurring Billing service or assigned by the merchant)
  7. Choose a subscription billing plan. You can choose an existing active plan or create a new one-time plan.
  8. Click Apply.
  9. If you selected a new one-time plan, you must complete these billing details:
    • Currency
    • Billing amount
    • Billing frequency. Choose one of the predefined options or click Custom to create your own. Enter the billing period length (number) and billing period unit. The interval between subscription payments cannot exceed 12 months.
    • Billing cycle options (a bill indefinitely subscription continues without a defined end date until it is manually cancelled by the merchant).
    • Number of billing cycles (enter a number in the billing cycles field).
  10. (Optional) Enter a set-up fee, which is an amount that is added to the first payment.
  11. (Optional) Enter a differential fee:
    • Enter the Surcharge Amount. Click Calculate to automatically calculate an amount.
    • Enter the Surcharge Description.
  12. Click Create Now. The Subscription Details page appears.

View a Subscription

You can view subscription details, including payment history and the next scheduled payment.

Follow these steps to view a subscription:

  1. On the left navigation panel, choose Recurring Billing > Manage Subscriptions. The Manage Subscriptions page appears.
  2. To search for subscriptions, click Add a Filter, and choose one of these filters:
    • Subscription code
    • First name
    • Last name
    • Plan name
    • Subscription status
  3. Enter the exact information. Search results appear in the list.
  4. To view the details for a subscription, click the subscription code. The Subscription Details page appears.

Edit a Subscription

You can edit subscription details including the plan, billing amount, and status.

You can add a differential fee to a subscription using the Surcharge Amount and Surcharge Description fields when you edit 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.

Follow these steps to edit a subscription:

  1. On the left navigation panel, choose Recurring Billing > Manage Subscriptions. The Manage Subscriptions page appears.
  2. Find the subscription and click the subscription code. The Subscription Details page appears.
  3. Click Edit. The Edit Subscription page appears.
  4. To change the status of the subscription, click Suspend Subscription or Cancel Subscription.
  5. To edit the subscription, click Edit.
  6. Edit any of these options:
    • Subscription code
    • Subscription name
    • Plan option
    • Billing amount
  7. Click Update. The Subscription Details page appears.

Reactivate a Suspended Subscription

You can reactivate a suspended subscription for the next billing cycle.

Follow these steps to reactivate a subscription:

  1. In the , navigate to Recurring Billing > Manage Subscriptions. The Manage Subscriptions page opens.
  2. Find the subscription and click the subscription code. The Subscription Details page opens.
  3. To reactivate the subscription, click Change Status and then select Reactivate. The confirmation window appears.
  4. Depending on the reactivation settings:
    • Ask each time before reactivating: the system displays information about the number and total monetary amount of missed payments that occurred when the subscription was in a suspended state. You can then choose one of these options:
      • Process missed payments and fees: processes the transactions that were missed when the subscription was suspended.
      • Only process future payments: does not process the transactions that were missed when the subscription was suspended.
    • Always process all missed payments: the system displays information about the number and total monetary amount of missed payments that occurred when the subscription was in a suspended state.
    • Do not process any missed payments: the displays a total amount equal to 0.00.
  5. Click Reactivate.

Skip Payments within a Subscription

There are two ways that you can stop and restart subscription payments:

  • Use the Suspend function to pause subscription payments. You can reactivate payments at any time and choose whether to retry any payments that were missed while the subscription was suspended.
  • When the period of skipped payments is known, you can choose the Skip option from the Subscription Details Page.

You can skip a single payment or set of future payments. Follow these steps to skip a payment:

  1. In the , navigate to Recurring Billing > Manage Subscriptions. The Manage Subscriptions page opens.
  2. Find the subscription and click the subscription code. The Subscription Details page opens.
  3. To skip a scheduled payment within the subscription, navigate to the scheduled payments and click the Skip option next to the date of the payment that you want to skip. The confirmation window appears.

To restore a skipped payment, navigate to the scheduled payments, and click Restore next to the payment date.

Last published: September 29, 2026