The Cancel Recurring Application Charge API is used to cancel a recurring application charge subscription. This API does not delete the subscription but updates its status to reflect the cancellation. In RESTful API design, a DELETE request can imply logical deletion or physical deletion. In this case, the subscription remains in the database, but its status is updated to indicate it has been canceled.
This API is especially useful for:
Managing subscription cancellations without deleting the record.
Auditing and tracking canceled subscriptions.
Maintaining a consistent history of subscription changes.
Note: The operation updates fields such as canceled_on, updated_at, and status to reflect the cancellation.
Error responses in the API can be represented using two different fields: errors and error. Both fields provide details about issues encountered during request processing. Below is an explanation of the fields with their respective examples and descriptions.
Field
Type
Example
Description
errors
Array
[ "file number error"]
A list of errors encountered during the request processing.
Field
Type
Example
Description
error
String
"page not found"
Indicates an error encountered during the process
Error Detail
Status Code
Message
Possible Reason
Example Response
400
Bad Request
Invalid input format or request structure (e.g., missing required fields or incorrect data types).
Bad Request
Unauthorized
The request is missing valid authentication credentials or the credentials provided are invalid.
Unauthorized
404
Not Found
The charge Id is not found.
"Record not found"
422
Unprocessable Entity
The charge Id is empty.
"ChargedId is required"
API Structure Overview
Language
Credentials
Header
URL
Click Try It! to start a request and see the response here!
