Cancel Recurring Application

Cancel a recurring application charge subscription.

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:

  1. Managing subscription cancellations without deleting the record.
  2. Auditing and tracking canceled subscriptions.
  3. Maintaining a consistent history of subscription changes.

Request Parameters

Public Request Parameters

📘

Path Parameters

ParameterTypeRequiredDescriptionExample
charge_idstringrequiredThe unique identifier of the recurring charge37222669345671159

Response Description

Public Response Fields

📘

Success Response

FieldTypeExampleDescription
codestring"success"Status code of the response
messagestringDescriptive message of the response
dataobject{...}

Error Response

FieldTypeExampleDescription
codestringInvalidParameterError http message
messagestring``Error message
Language
Credentials
Header
URL
Click Try It! to start a request and see the response here!