Billing APIs

Billing API is a RESTful API that allows setting up customers, collecting payments and maintaining balances for these customers, as well as creating recurring billing subscriptions.

Billing API documentation includes the following sections:

Objects - lists all recurring billing objects. The purpose of this section is to describe all object fields, their format and usage, provide the links to the corresponding database tables.

Type Enumerations – lists possible values that can be used in the respective fields within Billing API requests and responses. The purpose of this section is to provide an explanation of all enumerations used for API calls.

Actions - lists all actions that can be performed with key recurring billing objects. The purpose of this section is to describe the methods and format of API requests and the format of responses.

Integration Notes – lists integration notes associated with the Billing API objects and actions. The purpose of this section is to provide explicit information about the peculiarities of specific actions and object fields.

Code samples - provides examples of recurring billing use cases (creating billing plans, subscriptions, freeing or canceling subscriptions, reversing transactions, etc) and their implementation in JSON, XML, XURL formats. The purpose of this section is to provide examples that can be used for testing of the integration with the gateway.

To learn how to work with the Billing API, we recommend reviewing the integration notes first. Key recurring billing module terms are available here. For more detailed information about the recurring billing configurations and management, check the Recurring Billing Guide.

Base Resource URL:



Provides access to customers registered within the system.

Available sub-resources:

Resource URL Description
https://[server-name]/api/v01/customers/[customer-id]    Provides access to configuration settings for the specified customer.

Supported Actions:

Method:  PUT       Implicit:  Yes       Returns:  Customer      
Consumes:  json, xml  Produces:  json, xml 
Creates a customer.

# Name Type Required Default Description
01 object Customer Yes Represents information about the customer.

Method:  GET       Implicit:  Yes       Returns:  Customer[]      
Consumes:  xurl  Produces:  json, xml 
Returns a list of available customers based on specified search criteria.

# Name Type Required Default Description
01 offset Integer No 0 Index of the first record returned to the customer from the search result of a web search.
02 limit Integer No 100 Maximum number of records to load per single search web call made by the customer.
03 accountId Integer No Identifier of the account within the gateway.
04 firstName String(125) No The first name of the customer.
05 lastName String(125) No The last name of the customer.
06 organizationName String(255) No Name of the organization associated with the customer.
07 email String(100) No Email address of the customer.
08 phone String(15) No Phone number of the customer.
09 street String(128) No Street address of the customer.
10 city String(50) No City of the customer.
11 state String(3) No State of the customer.
12 zipCode String(10) No ZIP or postal code of the customer.
13 countryCode String(2) No Country code of the customer's address.