Get Started

Use this guide to take your first steps with Recurring Billing. If you are not sure which method to use, see the Recurring Billing Overview.

Get Started Using the REST API

The REST API is the right choice if you need to integrate Recurring Billing directly into your payment system or automate plan and subscription management programmatically.

Prerequisites

Before making API requests, ensure the following:

• Your account is enabled for Recurring Billing and Token Management Service (TMS). Contact your representative to enable these services.
• For more information about TMS, see the Token Management Service Developer Guide.

Steps

1. Register for REST API credentials: if you have not already, register and obtain authentication credentials for the REST API. When your system is REST compliant, test the integration by sending requests to the test server. See the Getting Started with the REST API Guide.

2. Create a customer token: before creating a subscription, create a TMS customer token. The token stores the customer's payment, billing, and shipping information securely. The TMS response provides the tokenInformation.customer.id and processorInformation.networkTransactionId values required in the subscription request.

3. Create a plan: send a POST /rbs/v1/plans request with the billing schedule details. The response returns a plan ID used when creating subscriptions. See Manage Plans for the full field reference.

   Required fields:

   Expand all

   orderInformation.amountDetails.billingAmount string · Required

   Billing amount for each payment cycle.

   orderInformation.amountDetails.currency string · Required

   ISO currency code (for example, USD).

   planInformation.billingPeriod.unit string · Required

   Billing period unit: d (daily), w (weekly), m (monthly), or y (yearly).

   planInformation.billingPeriod.length string · Required

   Number of period units between billing cycles.

   planInformation.name string · Required

   Descriptive name for the plan.

4. Create a subscription: send a POST /rbs/v1/subscriptions request with the customer token, plan ID, and start date. The response returns a subscription ID for use in subsequent requests. See Manage Subscriptions for the full field reference.

   Required fields:

   Expand all

   paymentInformation.customer.id string · Required

   TMS customer token ID from the token creation response.

   subscriptionInformation.planId string · Required

   Plan ID returned by the POST /rbs/v1/plans request.

   subscriptionInformation.name string · Required

   Descriptive name for the subscription.

   subscriptionInformation.startDate string · Required

   Start date in UTC format: YYYY-MM-DDThh:mm:ssZ. For subscriptions created on the start date, the time value must be the current time and day in the applicable time zone.

Get Started Using the

The is the right choice if you prefer to manage Recurring Billing plans and subscriptions through the web portal.

Prerequisites

• A account with Recurring Billing permissions. The permission is called View or manage settings under Recurring Billing and can be configured in Account Management > Roles.
• Access to the for your environment:

Steps

1. Log in to the : use the URL for your environment listed in Prerequisites above. After logging in, choose Recurring Billing in the left navigation bar.

2. Configure notification settings: to send email notifications to customers about recurring payments:

   1. In the left navigation menu, choose Recurring Billing > Manage Subscriptions or Recurring Billing > Manage Plans.
   2. In the upper-right corner of the page, click the Settings button.
   3. Click the Notifications tab.
   4. Click Yes, send the customer notifications. The available email notification types appear on the right side of the page.

3. Configure reactivation settings: to set how missed payments are handled when a suspended subscription is reactivated:

   1. In the left navigation menu, choose Recurring Billing > Manage Subscriptions or Recurring Billing > Manage Plans.
   2. In the upper-right corner of the page, click the Settings button.
   3. Click the Payments tab to configure whether missed payments are collected on reactivation.

4. Create a plan: create the billing schedule that defines payment frequency, amount, and currency. See Manage Plans for detailed instructions.

5. Create a subscription: link a customer payment token to the plan and set the subscription start date. See Manage Subscriptions for detailed instructions.