REST API

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.