Billing Plans

Overview

Billing plans eliminate the need to manage your own cron job scheduler. Simply configure the payment frequency, and our system automatically processes payments on schedule by initiating authorization requests to the gateway using tokenized payment data stored in your Vault.

This gives you complete control over recurring payments through a simple API integration.

How It Works

Setting up a billing plan involves three key steps: tokenizing payment data, configuring your plan details, and creating the plan via API.

Before you begin: Ensure you comply with card brand requirements for obtaining consent to store and reuse cardholder data. See the Card on File section for detailed information.

Step 1: Tokenize and Store Payment Data

First, securely tokenize the customer’s payment data and store it in a Vault using one of these methods:

Option A: Using runner.js

Render a hosted iFrame tokenizer with runner.js, retrieve the generated token, and store it as a Vault by including vault: "Y" in your subsequent charge request.

Option B: Using the API directly

Call the Create Vault Payment Account endpoint to create a new Vaulted Payment Method.

Step 2: Configure Your Billing Plan

You’ll need the following information to create your billing plan:

Step 3: Create the Billing Plan

Make a POST request to the Create Billing Plan endpoint with your configuration:

Request

1
{
2
  "name": "Testing Payment Plan",
3
  "description": "Rental Payments",
4
  "mid": "800000001780",
5
  "payment_account_uuid": "1f0bb43e-a184-6f30-a618-7784b6d018bc",
6
  "amount": "120.00",
7
  "rrule_pattern": "DTSTART:20270101T090000Z\nRRULE:FREQ=DAILY;INTERVAL=1;UNTIL=20270110T235959Z"
8
}

Response

1
{
2
  "id": 6549
3
}