cancelRecurringPayment

MUTATION

Once a recurring payment is cancelled, it cannot be reactivated.

Arguments

recurring_idRequired

String

The recurring_id of the recurring payment to be cancelled.

Response

Boolean

Examples

Cancel a recurring schedule

Cancels a schedule. Get it with recurringPayments afterward to confirm is_active is false.

SUCCESS 200

GRAPHQL

mutation CancelRecurringPayment($recurring_id: String!) {
  cancelRecurringPayment(recurring_id: $recurring_id)
}