Sign in
latestOpenAPI 3.0.3MIT2026-08-10121945.1 KB

a52c87b9a2b9

Recurring Payments

Cancel a recurring payment

This cancels the recurring payment for the reference provided. Recurring payment references start with tbx-r-

delete/recurring-payments/{reference}

Path parameters

referencestring required
Example:tbx-r-55fff4107740a1f40d844ff89607557f45bfafb3

The recurring payment reference to cancel.

Response

Recurring payment cancelled successfully.

idinteger
created_atstring date-time
updated_atstring date-time
paused_atstring date-time nullable
paused_untilstring date-time nullable
next_payment_datestring
referencestring
account_idinteger
intervalstring
cancelled_atstring date-time nullable
cancellation_requested_atstring date-time nullable
cancel_reasonstring nullable

Example response

{
  "id": 5000,
  "created_at": "2022-12-16T16:43:06.000000Z",
  "updated_at": "2022-12-16T16:43:06.000000Z",
  "next_payment_date": "2022-12-30T16:43:06",
  "reference": "88",
  "account_id": 1,
  "interval": "P2W",
  "cancellation_requested_at": "2024-07-25 14:01:03",
  "status": {
    "id": 2,
    "class": "success",
    "description": "Active",
    "active": 1
  },
  "amount": {
    "amount": 7,
    "tax": 1.4,
    "period": "P2W"
  },
  "links": {
    "initial_payment": "https://checkout.tebex.io/api/payments/tbx-123123aabccd123-bf71ad?type=txn_id",
    "payment_history": [
      "https://checkout.tebex.io/api/payments/tbx-123123aabccd123-bf71ad?type=txn_id"
    ]
  }
}