Sign in

v1

latestOpenAPI 3.1.0Copyright Pismo2026-07-247702,7523.1 MB
Recurring charge links

Delete recurring charge link

Cancels the link between a recurring charge plan and an account. Results in the cancellation of all PENDING charges for that link. Already canceled links are unaffected. This endpoint generates a Recurring charge plan unlinked from account 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-links/{recurring_charge_link_id}

Path parameters

recurring_charge_link_idinteger required
Example:98660282

ID of the link between a plan and an account

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 canceled the link.

recurring_charge_link_idinteger

ID of recurring charge link

account_idinteger

Account ID

recurring_charge_plan_idinteger

ID of recurring charge plan

previous_recurring_charge_link_idinteger

ID of previous recurring charge link

org_idstring

Organization ID

created_atstring date-time

Datetime program calendar strategy was created. Format = YYYY-MM-DDTHH:MM:SS:MM.

cancelled_atstring

Date/time (GMT-3) that link was canceled

end_datestring date-time

End date for link (GMT-3). When the final charge for a link is made, end_date gets populated.

descriptionstring

A description of the scheduled charge that's linked to the account. Use counter to specify where the cycle count should be placed. Example: "Annuity {counter}" generates "Annuity 2/12" for the second of twelve annutities. If counter is not present, the counter is placed at the end of the description. If no description is configured, the description of the transaction type is used, and the counter is not shown.

tracking_idstring

Customer created tracking ID. Must consist of alphanumeric characters (a-z, A-Z, 0-9), hyphens (-), and colons (:), with a length from 1 to 128. The Pismo platform uses this field to implement idempotency and prevent duplicates.

creation_cidstring

CID for the creation event

cancellation_cidstring

CID for the cancellation event

Example response

{
  "recurring_charge_link_id": 98660282,
  "account_id": 6912345,
  "recurring_charge_plan_id": 115563,
  "org_id": "TN-cc8f8b89-233a-4582-9f36-63ee85278d6d",
  "created_at": "2024-09-12T16:46:16.43663522",
  "cancelled_at": "2023-03-30T12:26:41",
  "end_date": "2023-03-30T12:26:41",
  "description": "Link between an account and a recurring charge plan",
  "tracking_id": "3368328d-e4c6-4c75-99a9-9d59f3501d8c",
  "creation_cid": "3ea22692-a209-11eb-89a2-f73e179dcbc2",
  "cancellation_cid": "3ea22692-a209-11eb-89a2-f73e179dcbc2"
}