GoCardlessDeveloper Docs
Create a sandbox account

Subscription Events

Event types and causes for subscription resources.

Created#

The subscription has been created.

apisubscription_created

Subscription 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_granted

The 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_denied

The customer denied approval for this subscription

Amended#

The subscription amount has been changed.

apisubscription_amended

Subscription amount has been amended.

Payment Created#

A payment has been created by this subscription.

gocardlesspayment_created

Payment created by a subscription.

Cancelled#

This subscription has been cancelled. No further payments will be created.

bankbank_account_closed

This subscription was cancelled because the customer is deceased.

SchemeachReason codesACH_RETURN-R14ACH_RETURN-R15
bankreturn_on_odfi_request

This subscription has been cancelled because its mandate was cancelled.

SchemeachReason codesACH_RETURN-R06
bankrefer_to_payer

This subscription has been cancelled because the bank details for its mandate are incorrect.

SchemeachReason codesACH_RETURN-C01ACH_RETURN-C02ACH_RETURN-C03ACH_RETURN-C05ACH_RETURN-C06ACH_RETURN-C07ACH_RETURN-R08NOTIFICATION_OF_CHANGE-C01NOTIFICATION_OF_CHANGE-C02NOTIFICATION_OF_CHANGE-C03NOTIFICATION_OF_CHANGE-C05NOTIFICATION_OF_CHANGE-C06NOTIFICATION_OF_CHANGE-C07NOTIFICATION_OF_CHANGE-R08
bankbank_account_closed

This subscription has been cancelled because the bank account it was going to be taken from has been closed.

SchemeachReason codesACH_RETURN-R02ACH_RETURN-R12
bankmandate_cancelled

This subscription was canceled because the customer cancelled the mandate at their bank.

SchemeachReason codesACH_RETURN-R07
bankmandate_cancelled

This subscription has been cancelled because the bank details for its mandate are incorrect.

SchemeachReason codesACH_RETURN-R10
bankinvalid_bank_details

This subscription has been cancelled because the bank details for its mandate are incorrect.

SchemeachReason codesACH_RETURN-R03ACH_RETURN-R04ACH_RETURN-R13ACH_RETURN-R28ACH_RETURN-R82
bankdirect_debit_not_enabled

This subscription has been cancelled because the bank account it was going to be taken from does not support direct debit.

SchemeachReason codesACH_RETURN-R16ACH_RETURN-R20ACH_RETURN-R34
bankrefer_to_payer

This subscription has been cancelled because its mandate was cancelled.

SchemeachReason codesACH_RETURN-R16ACH_RETURN-R20ACH_RETURN-R29
bankauthorisation_disputed

This subscription has been cancelled because the customer disputes authorising its mandate.

SchemeachReason codesACH_RETURN-R05ACH_RETURN-R08ACH_RETURN-R10ACH_RETURN-R11ACH_RETURN-R29ACH_RETURN-R31ACH_RETURN-R51
apisubscription_cancelled

The subscription has been cancelled at your request.

apimandate_cancelled

The subscription was cancelled because its mandate was cancelled at your request.

apibank_account_closed

The mandate for this subscription was cancelled at your request.

gocardlessmandate_expired

The subscription was cancelled because its mandate has expired.

bankmandate_cancelled

The mandate for this subscription was cancelled at a bank branch.

SchemebacsReason codesADDACS-0ADDACS-1
bankbank_account_closed

The mandate for this subscription was cancelled as the customer's bank account has been closed.

SchemebacsReason codesADDACS-2ADDACS-B
bankbank_account_transferred

The 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.

SchemebacsReason codesADDACS-3ADDACS-CADDACS-E
bankauthorisation_disputed

The customer disputes authorising this mandate.

SchemebacsReason codesADDACS-D
bankbank_account_closed

This subscription was cancelled because the customer is deceased.

SchemebacsReason codesARUDD-2
bankrefer_to_payer

An error was received from the banks while setting up the mandate for this subscription.

SchemebacsReason codesARUDD-6
bankbank_account_closed

This subscription was cancelled because the customer closed their bank account before it could be collected.

SchemebacsReason codesARUDD-B
bankinvalid_bank_details

This subscription has been cancelled because the bank details for its mandate are incorrect.

Schemesepa_coreReason codesAC01BE06
bankbank_account_closed

This subscription has been cancelled because the bank account it was going to be taken from has been closed.

Schemesepa_coreReason codesAC04MD07
bankdirect_debit_not_enabled

This subscription has been cancelled because the bank account it was going to be taken from does not support direct debit.

Schemesepa_coreReason codesAG01AC06
bankaccount_blocked_for_any_financial_transaction

This subscription has been cancelled because the bank account for its mandate was blocked.

Schemesepa_coreReason codesAC06
bankauthorisation_disputed

This subscription has been cancelled because the payer disputes authorising its mandate.

Schemesepa_coreReason codesMD01
bankmandate_cancelled

This subscription has been cancelled because the payer disputes authorising its mandate.

Schemesepa_coreReason codesMD01
bankauthorisation_disputed

This subscription has been cancelled because the customer disputes authorising its mandate.

SchemebacsReason codesDDICA-3DDICA-4DDICA-5DDICA-6DDICA-8
bankbank_account_closed

This subscription has been cancelled because the bank account for its mandate has been closed.

SchemebacsReason codesAUDDIS-2AUDDIS-B
bankinvalid_bank_details

This subscription has been cancelled because the bank details for its mandate are not valid.

SchemebacsReason codesAUDDIS-5
bankbank_account_transferred

This 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.

SchemebacsReason codesAUDDIS-3AUDDIS-C
bankdirect_debit_not_enabled

This subscription has been cancelled because the bank account for its mandate does not support direct debit.

SchemebacsReason codesAUDDIS-FAUDDIS-GAUDDIS-N
bankinvalid_bank_details

This subscription has been cancelled because the bank details for its mandate are not valid.

SchemebacsReason codesARUDD-5ARUDD-YARUDD-E
bankmandate_cancelled

This subscription was canceled because the customer cancelled the mandate at their bank.

SchemebacsReason codesARUDD-1
apiplan_cancelled

The subscription has been cancelled because the associated plan was cancelled.

bankauthorisation_disputed

This subscription has been cancelled because the customer disputes authorising its mandate.

SchemebecsReason codesUDUNAUT
bankmandate_cancelled

This subscription has been cancelled because its mandate was cancelled.

SchemebecsReason codesCBC
bankdirect_debit_not_enabled

This subscription has been cancelled because the bank account for its mandate does not support direct debit.

SchemebecsReason codes2
bankpayment_stopped

The subscription was cancelled because the payment was stopped by the payer or their bank.

SchemebecsReason codes2
bankbank_account_closed

This subscription was cancelled because the customer is deceased.

SchemebecsReason codes4
bankinvalid_bank_details

This subscription has been cancelled because the bank details for its mandate are not valid.

SchemebecsReason codesDEN
bankbank_account_closed

This subscription has been cancelled because the bank account it was going to be taken from has been closed.

Schemebecs_nzReason codesDISHONOUR-AC04
bankinvalid_bank_details

This subscription has been cancelled because the bank details for its mandate are not valid.

SchemepadReason codesPAYMENT_STATUS_REPORT-900PAYMENT_STATUS_REPORT-902PAYMENT_STATUS_REPORT-912PAYMENT_STATUS_REPORT-1023PAYMENT_STATUS_REPORT-2014PAYMENT_STATUS_REPORT-2017PAYMENT_STATUS_REPORT-2018PAYMENT_STATUS_REPORT-2019PAYMENT_STATUS_REPORT-2020PAYMENT_STATUS_REPORT-2034PAYMENT_STATUS_REPORT-0518PAYMENT_STATUS_REPORT-0567PAYMENT_STATUS_REPORT-0573
bankbank_account_closed

This subscription has been cancelled because the bank account for its mandate has been closed.

SchemepadReason codesPAYMENT_STATUS_REPORT-905
bankdirect_debit_not_enabled

This subscription has been cancelled because the bank account for its mandate does not support direct debit.

SchemepadReason codesPAYMENT_STATUS_REPORT-907
bankbank_account_closed

This subscription was cancelled because the customer is deceased.

SchemepadReason codesPAYMENT_STATUS_REPORT-910
bankauthorisation_disputed

This subscription has been cancelled because the customer disputes authorising its mandate.

SchemepadReason codesPAYMENT_STATUS_REPORT-915
bankother

An error was received from the banks while setting up the mandate for this subscription.

SchemepadReason codesPAYMENT_STATUS_REPORT-914
bankrefer_to_payer

An error was received from the banks while setting up the mandate for this subscription.

SchemepadReason codesPAYMENT_STATUS_REPORT-914
bankmandate_cancelled

This subscription has been cancelled because its mandate was cancelled.

SchemepadReason codesPAYMENT_STATUS_REPORT-917PAYMENT_STATUS_REPORT-920
bankmandate_cancelled

This subscription has been cancelled because its mandate was cancelled.

Schemefaster_paymentsReason codesPAYER_MANDATE_CANCELLED
bankmandate_cancelled

This subscription has been cancelled because its mandate was cancelled.

Schemefaster_paymentsReason codesMANDATE_CANCELLED_BY_BANK
bankmandate_cancelled

This subscription has been cancelled because its mandate was cancelled.

Schemefaster_paymentsReason codesFAILED_ELIGIBILITY_CHECK
bankmandate_suspended_by_payer

The subscription has been cancelled because its mandate was suspended by payer.

Schemepay_toReason codesSBP
bankmandate_cancelled

The mandate for this subscription was cancelled by the customer or bank.

Schemepay_toReason codesMD16
bankbank_account_closed

This subscription has been cancelled because the bank account it was going to be taken from has been closed.

Schemepay_toReason codesAC05
gocardlessmandate_cancelled

The mandate for this subscription was cancelled at your request.

Schemefaster_paymentsReason codesMERCHANT_MANDATE_CANCELLED
gocardlessmandate_cancelled

The subscription was cancelled because its mandate has expired.

Schemefaster_paymentsReason codesMANDATE_EXPIRED
gocardlessinitial_one_off_payment_failed

This subscription has been cancelled because its mandate was cancelled.

Finished#

This subscription has finished. No further payments will be created.

gocardlesssubscription_finished

The subscription has finished.

Paused#

This subscription has been paused.

apisubscription_paused

The subscription has been paused.

gocardlesssubscription_paused

The subscription has been paused.

Resumed#

This subscription was resumed.

apisubscription_resumed

The subscription was resumed.

gocardlesssubscription_resumed

The subscription was resumed.

Scheduled Pause#

This subscription has been scheduled to be paused at a future date.

apischeduled_pause

The 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_cancelled

An upcoming pause for this subscription has been cancelled.

Scheduled Resume#

This paused subscription has been scheduled to be resumed at a future date.

apischeduled_resume

This paused subscription has been scheduled to be resumed at a future date.