Skip to main content

Cancel Agreement Payments ( Repeat Billing)

In this manual, we will guide you on the correct method to Cancel Agreement using a specified endpoint. We strongly recommend that you and your team review theRepeat Billing API Workflow manual first to grasp the business logic behind this integration type.

POST{{domain}}/payment/agreement/cancel
Be Aware Of

Please note that not using the proper endpoint URL {domain} will lead to authentication issues within your responses. To find the your proper domain you can read ourWhat is my (Region)/(endpoint URL)?tutorial article.

https://secure.paytabs.sa/payment/agreement/cancel

How to Cancel Agreement ?


When you create an agreement, it defines a clear payment plan for the customer, specifying the amounts due each month, week, or day. If this agreement changes for any reason beyond your control, you must cancel it. You have the option to pause or cancel it from the dashboard. click here to know more Repeat Billing & Repeat Invoicing

Through the API, only cancellation is supported, and it’s recommended to use the API if the agreement was created via API. This ensures the cancellation response aligns with your system and updates correctly. Please follow the steps below to review the request and response.


The Minimum Required Parameters

To initiate cancel agreement request, there are minimum required parameters that need to be passed with valid information. The specification of these required parameters is clarified below according to the query type:

In the PUT request type, you can cancel the status by sending a PUT request with only the { AGREEMENT_ID } as a parameter in the URL Along with the server key ( authentication you already know about ). Below is a sample request that demonstrates how to cancel the agreement with the ID "2075865."

Alt text

Request & Response Payload Samples

In the PUT request type, you can cancel the status by sending a PUT request with only the { AGREEMENT_ID } as a parameter in the URL Along with the server key ( authentication you already know about ). Below is a sample request that demonstrates how to cancel the agreement with the ID "2075865."

Alt text

The Merchant Dashboard Page Experience​

once you cancel the agreement and receive the response, update your system accordingly. In your dashboard, the agreement will appear as shown below:

Alt text

We are glad to be always in help. We aim to serve you better each time. As such, please spare a minute to share feedback about your recent experience with PayTabs Developers , on Trustpilot, or Google Reviews.