Subscription Events
Event types and causes for subscription resources.
Created#
The subscription has been created.
apisubscription_createdSubscription created via the API.
Customer Approval Granted#
The subscription required additional approval from the customer before it could become active, and that approval has been granted.
customercustomer_approval_grantedThe customer granted approval for this subscription
Customer Approval Denied#
The subscription required additional approval from the customer before it could become active, and that approval has been denied.
customercustomer_approval_deniedThe customer denied approval for this subscription
Amended#
The subscription amount has been changed.
apisubscription_amendedSubscription amount has been amended.
Payment Created#
A payment has been created by this subscription.
gocardlesspayment_createdPayment created by a subscription.
Cancelled#
This subscription has been cancelled. No further payments will be created.
bankbank_account_closedThis subscription was cancelled because the customer is deceased.
bankreturn_on_odfi_requestThis subscription has been cancelled because its mandate was cancelled.
bankrefer_to_payerThis subscription has been cancelled because the bank details for its mandate are incorrect.
bankbank_account_closedThis subscription has been cancelled because the bank account it was going to be taken from has been closed.
bankmandate_cancelledThis subscription was canceled because the customer cancelled the mandate at their bank.
bankmandate_cancelledThis subscription has been cancelled because the bank details for its mandate are incorrect.
bankinvalid_bank_detailsThis subscription has been cancelled because the bank details for its mandate are incorrect.
bankdirect_debit_not_enabledThis subscription has been cancelled because the bank account it was going to be taken from does not support direct debit.
bankrefer_to_payerThis subscription has been cancelled because its mandate was cancelled.
bankauthorisation_disputedThis subscription has been cancelled because the customer disputes authorising its mandate.
apisubscription_cancelledThe subscription has been cancelled at your request.
apimandate_cancelledThe subscription was cancelled because its mandate was cancelled at your request.
apibank_account_closedThe mandate for this subscription was cancelled at your request.
gocardlessmandate_expiredThe subscription was cancelled because its mandate has expired.
bankmandate_cancelledThe mandate for this subscription was cancelled at a bank branch.
bankbank_account_closedThe mandate for this subscription was cancelled as the customer's bank account has been closed.
bankbank_account_transferredThe mandate for this subscription was cancelled as the customer asked their bank to transfer the mandate to a new account, but the bank has failed to send GoCardless the new bank details.
bankauthorisation_disputedThe customer disputes authorising this mandate.
bankbank_account_closedThis subscription was cancelled because the customer is deceased.
bankrefer_to_payerAn error was received from the banks while setting up the mandate for this subscription.
bankbank_account_closedThis subscription was cancelled because the customer closed their bank account before it could be collected.
bankinvalid_bank_detailsThis subscription has been cancelled because the bank details for its mandate are incorrect.
bankbank_account_closedThis subscription has been cancelled because the bank account it was going to be taken from has been closed.
bankdirect_debit_not_enabledThis subscription has been cancelled because the bank account it was going to be taken from does not support direct debit.
bankaccount_blocked_for_any_financial_transactionThis subscription has been cancelled because the bank account for its mandate was blocked.
bankauthorisation_disputedThis subscription has been cancelled because the payer disputes authorising its mandate.
bankmandate_cancelledThis subscription has been cancelled because the payer disputes authorising its mandate.
bankauthorisation_disputedThis subscription has been cancelled because the customer disputes authorising its mandate.
bankbank_account_closedThis subscription has been cancelled because the bank account for its mandate has been closed.
bankinvalid_bank_detailsThis subscription has been cancelled because the bank details for its mandate are not valid.
bankbank_account_transferredThis subscription has been cancelled because the customer has requested for direct debits to be taken from a new account, but their bank did not send GoCardless the new bank details.
bankdirect_debit_not_enabledThis subscription has been cancelled because the bank account for its mandate does not support direct debit.
bankinvalid_bank_detailsThis subscription has been cancelled because the bank details for its mandate are not valid.
bankmandate_cancelledThis subscription was canceled because the customer cancelled the mandate at their bank.
apiplan_cancelledThe subscription has been cancelled because the associated plan was cancelled.
bankauthorisation_disputedThis subscription has been cancelled because the customer disputes authorising its mandate.
bankmandate_cancelledThis subscription has been cancelled because its mandate was cancelled.
bankdirect_debit_not_enabledThis subscription has been cancelled because the bank account for its mandate does not support direct debit.
bankpayment_stoppedThe subscription was cancelled because the payment was stopped by the payer or their bank.
bankbank_account_closedThis subscription was cancelled because the customer is deceased.
bankinvalid_bank_detailsThis subscription has been cancelled because the bank details for its mandate are not valid.
bankbank_account_closedThis subscription has been cancelled because the bank account it was going to be taken from has been closed.
bankinvalid_bank_detailsThis subscription has been cancelled because the bank details for its mandate are not valid.
bankbank_account_closedThis subscription has been cancelled because the bank account for its mandate has been closed.
bankdirect_debit_not_enabledThis subscription has been cancelled because the bank account for its mandate does not support direct debit.
bankbank_account_closedThis subscription was cancelled because the customer is deceased.
bankauthorisation_disputedThis subscription has been cancelled because the customer disputes authorising its mandate.
bankotherAn error was received from the banks while setting up the mandate for this subscription.
bankrefer_to_payerAn error was received from the banks while setting up the mandate for this subscription.
bankmandate_cancelledThis subscription has been cancelled because its mandate was cancelled.
bankmandate_cancelledThis subscription has been cancelled because its mandate was cancelled.
bankmandate_cancelledThis subscription has been cancelled because its mandate was cancelled.
bankmandate_cancelledThis subscription has been cancelled because its mandate was cancelled.
bankmandate_suspended_by_payerThe subscription has been cancelled because its mandate was suspended by payer.
bankmandate_cancelledThe mandate for this subscription was cancelled by the customer or bank.
bankbank_account_closedThis subscription has been cancelled because the bank account it was going to be taken from has been closed.
gocardlessmandate_cancelledThe mandate for this subscription was cancelled at your request.
gocardlessmandate_cancelledThe subscription was cancelled because its mandate has expired.
gocardlessinitial_one_off_payment_failedThis subscription has been cancelled because its mandate was cancelled.
Finished#
This subscription has finished. No further payments will be created.
gocardlesssubscription_finishedThe subscription has finished.
Paused#
This subscription has been paused.
apisubscription_pausedThe subscription has been paused.
gocardlesssubscription_pausedThe subscription has been paused.
Resumed#
This subscription was resumed.
apisubscription_resumedThe subscription was resumed.
gocardlesssubscription_resumedThe subscription was resumed.
Scheduled Pause#
This subscription has been scheduled to be paused at a future date.
apischeduled_pauseThe subscription has been scheduled to be paused at a future date.
Scheduled Pause Cancelled#
An upcoming pause for this subscription has been cancelled.
apischeduled_pause_cancelledAn upcoming pause for this subscription has been cancelled.
Scheduled Resume#
This paused subscription has been scheduled to be resumed at a future date.
apischeduled_resumeThis paused subscription has been scheduled to be resumed at a future date.