PIpismo
Recurring charge plans

Disable recurring charge plan

Disables an active recurring charge plan. Already disabled plans are unaffected. This endpoint generates a Recurring charge plan disabled event.

NOTE: This endpoint requires an account token — an access token encoded with an account ID. Tokens can expire quickly, which can result in a 401 Unauthorized message.

delete/v1/recurring-charge-plans/{recurring_charge_plan_id}

Request

  • Base URL
    https://sandbox.pismolabs.io/recurring-charge
  • URL
    https://sandbox.pismolabs.io/recurring-charge/v1/recurring-charge-plans/{recurring_charge_plan_id}
  • Auth
    HTTP bearer

Path parameters

recurring_charge_plan_idinteger required
Example:98660282

ID of the recurring charge plan

Headers

x-cidstring

The Correlation IDentifier field is used to link related API requests and events. The x-cid can help the Pismo engineering team track everything related to a call. You can find the x-cid field in the response header from an API endpoint call.

If this field isn't passed, one is automatically generated.

Response

OK - Indicates that the server accepted the request and disabled the plan.

recurring_charge_plan_idinteger

ID of recurring charge plan

disabled_atstring date-time

Date and time plan was disabled

disable_all_accountsboolean

Example response

{
  "recurring_charge_plan_id": 115563
}

Changes

No recorded changes to this operation across all 1 revision of this API.