Get Billing Agreement
Returns the specific billing agreement from its id
Authorization
BearerAuth In: header
Path Parameters
The id of the agreement to fetch.
Response Body
application/json
application/json
application/json
application/json
Create Billing Agreement
Creates a new Billing Agreement based on an existing Subscription and a Billing Plan . A billing agreement represents a scheduled payment relationship between the merchant and the cardholder, managed automatically by ePay. It links a subscription and a plan together, allowing ePay to handle recurring charges according to the plan’s configuration - for example, charging the customer monthly based on the defined price and interval. Important: Billing agreements is an optional extension of the base subscription and is only necessary if you want ePay to automatically manage recurring or interval-based billing on your behalf. If you only need to perform unscheduled MIT (Merchant-Initiated Transaction) payments - meaning you trigger the charge manually via the API whenever needed - you do not need to create a billing agreement or billing plan. In that case, use the existing Subscription created through the Initialize Payment Session /cit endpoint, and perform MIT transactions directly. Relationship to other components - Subscription: The underlying link between a merchant and a stored payment method. Created via the Initialize Payment Session /cit endpoint by sending the Subscription object. - Billing Plan: Defines recurring details like price, interval, and retry policy. Used only when ePay manages the billing schedule automatically. - Billing Agreement: Connects a Subscription to a Billing Plan. Tracks scheduled processing and charge lifecycle. - Billing Agreement Charge: Represents a scheduled billing event created from an agreement. Each charge can have multiple transaction attempts and a completion deadline. - Transaction: The base payment model used for all processing. Charges and transactions are linked to maintain attempt history.
Stop Billing Agreement
Stop automatic billing charges for the given billing agreement. No more automatic charges will be made for the agreement, until /resume is called.