Billing APIs

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

Customer

Type:  
Abstract:  no
Status:  Active
Java Class:  CustomerAccount
Represents information about the customer.

Available Fields:

# Name Type Pattern Format Mode Usage Description
1 phone String NUMERIC R Phone number of the customer.\n\r\n> **Note:** May include country code for international numbers.
2 street1 String(128) STREET O Street address of the customer (line 1).
3 street2 String(128) STREET O Street address of the customer (line 2).\n\r\n> **Note:** Contains additional address details such as an apartment or suite number.
4 organizationName String(255) NAME_BUSINESS O Name of the organization associated with the customer.\n\r\n> **Note:** This is a user-provided freeform field and does not represent any other data structure or object.
5 email String(100) EMAIL O Email associated with the customer.\n\r\n> **Tip:** This email can be used for customer communications and notifications.
6 holderName String(500) R O Calculated field that combines the firstName and lastName.\n\r\n> **Note:** Automatically generated by combining the first name and last name, separated by a space. This field is computed by the system and cannot be modified manually.\n\r\n> **Tip:** Use webhooks to track changes to compound fields like this one.
7 createDate Datetime R O Date when the customer was created.\n\r\n> **Note:** Format: yyyy-MM-dd HH:mm:ss. Automatically generated by the system.
8 address String(321) R O Complete customer address as a single string.\n\r\n> **Note:** Automatically generated by concatenating the `street1`, `street2`, `city`, `state`, `zipCode`, and `countryCode` fields. This field is computed by the system and cannot be modified manually.
9 balance Integer R O Balance of the customer in cents.\n\r\n> **Note:** Amount is specified in cents rather than dollars (e.g., $5.00 = 500).
10 id Long R O System-generated unique identifier for the customer.\n\r\n> **Note:** Automatically generated by the system upon successful customer creation.
11 code String(60) CODE C O Optional secondary identifier provided in the request.\n\r\n> **Note:** If not specified in the request, defaults to the same value as the object's id. Useful for cross-referencing with your system.\n\r\n> **Tip:** Providing consistent external identifiers improves integration capabilities.
12 accountId Integer C R Indicates the merchant account used to create the customer.\n\r\n> **Note:** Identifies the merchant account under which this customer was created.
13 createDate Datetime R O Date when the customer was created.\n\r\n> **Note:** Format: yyyy-MM-dd HH:mm:ss. Automatically generated by the system.
14 firstName String(125) NAME R First name of the customer.\n\r\n> **Note:** For organizations, this field contains the first name of the company's contact person.
15 lastName String(125) NAME R Last name of the customer.\n\r\n> **Note:** For organizations, this field contains the last name of the company's contact person.
16 email String EMAIL O Email associated with the customer.\n\r\n> **Tip:** This email can be used for customer communications and notifications.
17 isActive Boolean O Indicates whether the customer record is active within the system.\n\r\n> **Note:** Possible values: `true` (1) = active, `false` (0) = inactive. Default: `true`.
18 balance Integer R O Balance of the customer in cents.\n\r\n> **Note:** Amount is specified in cents rather than dollars (e.g., $5.00 = 500).
19 city String(50) ALPHANUMERIC_EXTENDED O The city of the customer.
20 countryCode String(2) ALPHA O The country code of the customer's address.\n\r\n> **Note:** Uses ISO 3166-1 alpha-2 standard. Example: US for United States, CA for Canada.
21 state String(3) O The state of the customer.\n\r\n> **Note:** Format is subject to the associated country code. For US addresses, uses two-letter state codes.
22 zipCode String(10) O The ZIP or postal code of the customer.\n\r\n> **Note:** Format is subject to the associated country code.
23 holderName String R O Calculated field that combines the firstName and lastName.\n\r\n> **Note:** Automatically generated by combining the first name and last name, separated by a space. This field is computed by the system and cannot be modified manually.\n\r\n> **Tip:** Use webhooks to track changes to compound fields like this one.
24 address String(321) R O Complete customer address as a single string.\n\r\n> **Note:** Automatically generated by concatenating the `street1`, `street2`, `city`, `state`, `zipCode`, and `countryCode` fields. This field is computed by the system and cannot be modified manually.
25 state String(3) ALPHA O The state of the customer.\n\r\n> **Note:** Format is subject to the associated country code. For US addresses, uses two-letter state codes.
26 zipCode String(10) ALPHANUMERIC_EXTENDED O The ZIP or postal code of the customer.\n\r\n> **Note:** Format is subject to the associated country code.

XML Sample:

<customer
    phone="" 
    street1="" 
    street2="" 
    organizationName="UnitedThinkers" 
    email="" 
    holderName="" 
    createDate="" 
    address="" 
    balance="" 
    id="" 
    code="" 
    accountId="" 
    createDate="" 
    firstName="John Smith" 
    lastName="John Smith" 
    email="" 
    isActive="" 
    balance="" 
    city="" 
    countryCode="" 
    state="" 
    zipCode="" 
    holderName="" 
    address="" 
    state="" 
    zipCode="" />

JSON Sample:

{
  "phone": "",
  "street1": "",
  "street2": "",
  "organizationName": "UnitedThinkers",
  "email": "",
  "holderName": "",
  "createDate": "",
  "address": "",
  "balance": "",
  "id": "",
  "code": "",
  "accountId": "",
  "firstName": "John Smith",
  "lastName": "John Smith",
  "isActive": "",
  "city": "",
  "countryCode": "",
  "state": "",
  "zipCode": ""
}

XURL Sample:

?phone=&street1=&street2=&organizationName=UnitedThinkers&email=&holderName=&createDate=&address=&balance=&id=&code=&accountId=&createDate=&firstName=John+Smith&lastName=John+Smith&email=&isActive=&balance=&city=&countryCode=&state=&zipCode=&holderName=&address=&state=&zipCode=&
phone=
street1=
street2=
organizationName=UnitedThinkers
email=
holderName=
createDate=
address=
balance=
id=
code=
accountId=
createDate=
firstName=John Smith
lastName=John Smith
email=
isActive=
balance=
city=
countryCode=
state=
zipCode=
holderName=
address=
state=
zipCode=
Copyright © United Thinkers. (UniPay - Payment Gateway Software)
All Logos and Trademarks used or mentioned on this page are copyrighted property of their respective owners and are used for display purposes only.