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.

Billing APIs Code Samples

Freeze payments in an existing Subscription

The customer is asking to freeze the subscription for the next three months starting from the next billing date.

Note: If you want to freeze the subscription starting from the specific date, it must be defined in the effectiveDate parameter in the request. If the effectiveDate parameter is not submitted in the request, the subscription is frozen starting from the next billing date.

View Implementation:

1) Freezing three upcoming payments in the existing subscription.
Method: GET
Path: [version]/customers/[customer-id]/subscriptions/[subscription-id]/~freeze
Parameters: effectiveDate=&length=3&note=Freeze+three+future+payments
Value Name
length 3
note Freeze three future payments