# CLI Reference Source: https://docs.gocardless.com/docs/developer-resources/gc-cli/cli-reference # CLI Reference `gocardless` is the official GoCardless CLI. `gc` is available as a shorter alias. - [Installation & setup](/docs/developer-resources/gc-cli) - [Testing Webhooks (CLI)](/docs/developer-resources/gc-cli/testing-webhooks-cli) --- ## gocardless A CLI to help you integrate GoCardless with your application ### Options ``` --config string config file (default is $HOME/.gc-cli/config.json) -h, --help help for gocardless -t, --toggle Help message for toggle ``` --- ## gocardless analytics disable Disable collection of statistics ``` gocardless analytics disable [flags] ``` ### Options ``` -h, --help help for disable ``` ### Options inherited from parent commands ``` --config string config file (default is $HOME/.gc-cli/config.json) ``` --- ## gocardless analytics enable Enable collection of statistics ``` gocardless analytics enable [flags] ``` ### Options ``` -h, --help help for enable ``` ### Options inherited from parent commands ``` --config string config file (default is $HOME/.gc-cli/config.json) ``` --- ## gocardless analytics status Status of analytics collections ``` gocardless analytics status [flags] ``` ### Options ``` -h, --help help for status ``` ### Options inherited from parent commands ``` --config string config file (default is $HOME/.gc-cli/config.json) ``` --- ## gocardless analytics Manage analytics collection ### Synopsis GoCardless collects metrics like crash logs and usage statistics. You can opt-out at any time using this command. Analytics are opt-in by default ``` gocardless analytics [flags] ``` ### Options ``` -h, --help help for analytics ``` ### Options inherited from parent commands ``` --config string config file (default is $HOME/.gc-cli/config.json) ``` --- ## gocardless cancel cancels the requested resource ### Synopsis This will call the cancel api for the requested resource and cancels it in GoCardless ``` gocardless cancel [flags] ``` ### Examples ``` gocardless cancel subscription SB1234 ``` ### Options ``` -h, --help help for cancel ``` ### Options inherited from parent commands ``` --config string config file (default is $HOME/.gc-cli/config.json) ``` --- ## gocardless completion Generate shell completion script ### Synopsis Generates shell completion script for the supported shells. See the examples for how to setup autocompletion for your shell. ``` gocardless completion [bash|zsh|fish|powershell] ``` ### Examples ``` #### Bash: $ source <(gc completion bash) # To load completions for each session, execute once: # Linux: $ gc completion bash > /etc/bash_completion.d/gc # macOS: $ gc completion bash > /usr/local/etc/bash_completion.d/gc #### Zsh: # If shell completion is not already enabled in your environment, # you will need to enable it. You can execute the following once: $ echo "autoload -U compinit; compinit" >> ~/.zshrc # To load completions for each session, execute once: $ gc completion zsh > "$/_gc" # You will need to start a new shell for this setup to take effect. #### fish: $ gc completion fish | source # To load completions for each session, execute once: $ gc completion fish > ~/.config/fish/completions/gc.fish #### PowerShell: PS> gc completion powershell | Out-String | Invoke-Expression # To load completions for every new session, run: PS> gc completion powershell > gc.ps1 # and source this file from your PowerShell profile. ``` ### Options ``` -h, --help help for completion ``` ### Options inherited from parent commands ``` --config string config file (default is $HOME/.gc-cli/config.json) ``` --- ## gocardless config current-session Get user's current session ### Synopsis This will return an output of the current session ``` gocardless config current-session [flags] ``` ### Examples ``` gocardless config current-session ``` ### Options ``` -h, --help help for current-session ``` ### Options inherited from parent commands ``` --config string config file (default is $HOME/.gc-cli/config.json) ``` --- ## gocardless config Get user's configuration ### Synopsis This returns requested configuration ### Options ``` -h, --help help for config ``` ### Options inherited from parent commands ``` --config string config file (default is $HOME/.gc-cli/config.json) ``` --- ## gocardless create create a resource on merchants account ### Synopsis This will call the POST api for the requested resource and uses the `--data` (or `-d`) flag to construct the data payload for the request. Otherwise you can use `--editorName vim`, then you can enter json and exit to submit. See a list of possible resources from the GoCardless API Reference:/docs/api-reference#core-endpoints ``` gocardless create [flags] ``` ### Examples ``` # create a payment linked to a mandate gocardless create payments -d amount=1000 -d currency=GBP -d "links[mandate]=MD1234" # create a payment with editor # opens vim prompt and then you can enter json data. gocardless create payments --editorName vim # create a subscription gocardless create subscriptions -d amount=1000 -d currency=GBP -d interval_unit=monthly -d "links[mandate]=MD1234" ``` ### Options ``` -d, --data stringArray Data for the API request --editorName string Pass an editor to read data from. -h, --help help for create ``` ### Options inherited from parent commands ``` --config string config file (default is $HOME/.gc-cli/config.json) ``` --- ## gocardless delete deletes the requested resource ### Synopsis This will call the delete api for the requested resource and removes it in GoCardless ``` gocardless delete [flags] ``` ### Examples ``` gocardless delete customer CU1234 ``` ### Options ``` -h, --help help for delete ``` ### Options inherited from parent commands ``` --config string config file (default is $HOME/.gc-cli/config.json) ``` --- ## gocardless get creditor Get creditor by ID ### Synopsis This will fetch a creditor using its ID ``` gocardless get creditor [flags] ``` ### Examples ``` gocardless get creditor XYZ12344 ``` ### Options ``` -h, --help help for creditor ``` ### Options inherited from parent commands ``` --config string config file (default is $HOME/.gc-cli/config.json) ``` --- ## gocardless get customer_bank_account Get customer bank account by ID ### Synopsis This will fetch a customer bank account using its ID ``` gocardless get customer_bank_account [flags] ``` ### Examples ``` gocardless get customer_bank_account XYZ12344 ``` ### Options ``` -h, --help help for customer_bank_account ``` ### Options inherited from parent commands ``` --config string config file (default is $HOME/.gc-cli/config.json) ``` --- ## gocardless get customer_notification Get customer notification by ID ### Synopsis This will fetch a customer notification using its ID ``` gocardless get customer_notification [flags] ``` ### Examples ``` gocardless get customer_notification XYZ12344 ``` ### Options ``` -h, --help help for customer_notification ``` ### Options inherited from parent commands ``` --config string config file (default is $HOME/.gc-cli/config.json) ``` --- ## gocardless get customer Get customer by ID ### Synopsis This will fetch a customer using its ID ``` gocardless get customer [flags] ``` ### Examples ``` gocardless get customer XYZ12344 ``` ### Options ``` -h, --help help for customer ``` ### Options inherited from parent commands ``` --config string config file (default is $HOME/.gc-cli/config.json) ``` --- ## gocardless get event Get event by ID ### Synopsis This will fetch a event using its ID ``` gocardless get event [flags] ``` ### Examples ``` gocardless get event XYZ12344 ``` ### Options ``` -h, --help help for event ``` ### Options inherited from parent commands ``` --config string config file (default is $HOME/.gc-cli/config.json) ``` --- ## gocardless get mandate_import Get mandate import by ID ### Synopsis This will fetch a mandate import using its ID ``` gocardless get mandate_import [flags] ``` ### Examples ``` gocardless get mandate_import XYZ12344 ``` ### Options ``` -h, --help help for mandate_import ``` ### Options inherited from parent commands ``` --config string config file (default is $HOME/.gc-cli/config.json) ``` --- ## gocardless get mandate Get mandate by ID ### Synopsis This will fetch a mandate using its ID ``` gocardless get mandate [flags] ``` ### Examples ``` gocardless get mandate XYZ12344 ``` ### Options ``` -h, --help help for mandate ``` ### Options inherited from parent commands ``` --config string config file (default is $HOME/.gc-cli/config.json) ``` --- ## gocardless get payer_authorisation Get payer authorisation by ID ### Synopsis This will fetch a payer authorisation using its ID ``` gocardless get payer_authorisation [flags] ``` ### Examples ``` gocardless get payer_authorisation XYZ12344 ``` ### Options ``` -h, --help help for payer_authorisation ``` ### Options inherited from parent commands ``` --config string config file (default is $HOME/.gc-cli/config.json) ``` --- ## gocardless get payment Get payment by ID ### Synopsis This will fetch a payment using its ID ``` gocardless get payment [flags] ``` ### Examples ``` gocardless get payment XYZ12344 ``` ### Options ``` -h, --help help for payment ``` ### Options inherited from parent commands ``` --config string config file (default is $HOME/.gc-cli/config.json) ``` --- ## gocardless get payout Get payout by ID ### Synopsis This will fetch a payout using its ID ``` gocardless get payout [flags] ``` ### Examples ``` gocardless get payout XYZ12344 ``` ### Options ``` -h, --help help for payout ``` ### Options inherited from parent commands ``` --config string config file (default is $HOME/.gc-cli/config.json) ``` --- ## gocardless get refund Get refund by ID ### Synopsis This will fetch a refund using its ID ``` gocardless get refund [flags] ``` ### Examples ``` gocardless get refund XYZ12344 ``` ### Options ``` -h, --help help for refund ``` ### Options inherited from parent commands ``` --config string config file (default is $HOME/.gc-cli/config.json) ``` --- ## gocardless get subscription Get subscription by ID ### Synopsis This will fetch a subscription using its ID ``` gocardless get subscription [flags] ``` ### Examples ``` gocardless get subscription XYZ12344 ``` ### Options ``` -h, --help help for subscription ``` ### Options inherited from parent commands ``` --config string config file (default is $HOME/.gc-cli/config.json) ``` --- ## gocardless get webhook Get webhook by ID ### Synopsis This will fetch a webhook using its ID ``` gocardless get webhook [flags] ``` ### Examples ``` gocardless get webhook XYZ12344 ``` ### Options ``` -h, --help help for webhook ``` ### Options inherited from parent commands ``` --config string config file (default is $HOME/.gc-cli/config.json) ``` --- ## gocardless get Fetch resources by their ID ### Synopsis With the get command you can fetch details of a resource by providing just the resource ID ### Examples ``` gocardless get mandate MD000EZSHACK2V gocardless get payment PA1000014 gocardless get event EV109280928 ``` ### Options ``` -h, --help help for get ``` ### Options inherited from parent commands ``` --config string config file (default is $HOME/.gc-cli/config.json) ``` --- ## gocardless list creditors List creditors ### Synopsis This will fetch a list of creditors ``` gocardless list creditors [flags] ``` ### Examples ``` gocardless list creditors ``` ### Options ``` -h, --help help for creditors ``` ### Options inherited from parent commands ``` --config string config file (default is $HOME/.gc-cli/config.json) ``` --- ## gocardless list customer_bank_accounts List customer bank accounts ### Synopsis This will fetch a list of customer bank accounts ``` gocardless list customer_bank_accounts [flags] ``` ### Examples ``` gocardless list customer_bank_accounts ``` ### Options ``` -h, --help help for customer_bank_accounts ``` ### Options inherited from parent commands ``` --config string config file (default is $HOME/.gc-cli/config.json) ``` --- ## gocardless list customer_notifications List customer notifications ### Synopsis This will fetch a list of customer notifications ``` gocardless list customer_notifications [flags] ``` ### Examples ``` gocardless list customer_notifications ``` ### Options ``` -h, --help help for customer_notifications ``` ### Options inherited from parent commands ``` --config string config file (default is $HOME/.gc-cli/config.json) ``` --- ## gocardless list customers List customers ### Synopsis This will fetch a list of customers ``` gocardless list customers [flags] ``` ### Examples ``` gocardless list customers ``` ### Options ``` -h, --help help for customers ``` ### Options inherited from parent commands ``` --config string config file (default is $HOME/.gc-cli/config.json) ``` --- ## gocardless list events List events ### Synopsis This will fetch a list of events ``` gocardless list events [flags] ``` ### Examples ``` gocardless list events ``` ### Options ``` -h, --help help for events ``` ### Options inherited from parent commands ``` --config string config file (default is $HOME/.gc-cli/config.json) ``` --- ## gocardless list mandate_imports List mandate imports ### Synopsis This will fetch a list of mandate imports ``` gocardless list mandate_imports [flags] ``` ### Examples ``` gocardless list mandate_imports ``` ### Options ``` -h, --help help for mandate_imports ``` ### Options inherited from parent commands ``` --config string config file (default is $HOME/.gc-cli/config.json) ``` --- ## gocardless list mandates List mandates ### Synopsis This will fetch a list of mandates ``` gocardless list mandates [flags] ``` ### Examples ``` gocardless list mandates ``` ### Options ``` -h, --help help for mandates ``` ### Options inherited from parent commands ``` --config string config file (default is $HOME/.gc-cli/config.json) ``` --- ## gocardless list payer_authorisations List payer authorisations ### Synopsis This will fetch a list of payer authorisations ``` gocardless list payer_authorisations [flags] ``` ### Examples ``` gocardless list payer_authorisations ``` ### Options ``` -h, --help help for payer_authorisations ``` ### Options inherited from parent commands ``` --config string config file (default is $HOME/.gc-cli/config.json) ``` --- ## gocardless list payments List payments ### Synopsis This will fetch a list of payments ``` gocardless list payments [flags] ``` ### Examples ``` gocardless list payments ``` ### Options ``` -h, --help help for payments ``` ### Options inherited from parent commands ``` --config string config file (default is $HOME/.gc-cli/config.json) ``` --- ## gocardless list payouts List payouts ### Synopsis This will fetch a list of payouts ``` gocardless list payouts [flags] ``` ### Examples ``` gocardless list payouts ``` ### Options ``` -h, --help help for payouts ``` ### Options inherited from parent commands ``` --config string config file (default is $HOME/.gc-cli/config.json) ``` --- ## gocardless list refunds List refunds ### Synopsis This will fetch a list of refunds ``` gocardless list refunds [flags] ``` ### Examples ``` gocardless list refunds ``` ### Options ``` -h, --help help for refunds ``` ### Options inherited from parent commands ``` --config string config file (default is $HOME/.gc-cli/config.json) ``` --- ## gocardless list subscriptions List subscriptions ### Synopsis This will fetch a list of subscriptions ``` gocardless list subscriptions [flags] ``` ### Examples ``` gocardless list subscriptions ``` ### Options ``` -h, --help help for subscriptions ``` ### Options inherited from parent commands ``` --config string config file (default is $HOME/.gc-cli/config.json) ``` --- ## gocardless list webhooks List webhooks ### Synopsis This will fetch a list of webhooks ``` gocardless list webhooks [flags] ``` ### Examples ``` gocardless list webhooks ``` ### Options ``` -h, --help help for webhooks ``` ### Options inherited from parent commands ``` --config string config file (default is $HOME/.gc-cli/config.json) ``` --- ## gocardless list List resources by type ### Synopsis This will fetch a list of resources for the resource type specified ### Examples ``` gocardless list payments gocardless list customers gocardless list events ``` ### Options ``` -h, --help help for list ``` ### Options inherited from parent commands ``` --config string config file (default is $HOME/.gc-cli/config.json) ``` --- ## gocardless listen Listen for new webhooks ### Synopsis This will listen for any new webhooks, and either forward them onto a URL if one is provided, or print them onto the screen. ``` gocardless listen [flags] ``` ### Examples ``` # listen for events and print them to console gocardless listen # listen for events and forward them to a webhook url gocardless listen --forward "http://localhost:8001/webhook" ``` ### Options ``` -f, --forward string optional url to forward webhooks to -h, --help help for listen ``` ### Options inherited from parent commands ``` --config string config file (default is $HOME/.gc-cli/config.json) ``` --- ## gocardless login Login authorises a new merchants session ### Synopsis With the login command you can authorize directly against the GC CLI or authorize against an app that belongs to you if you are building a partner integration. You can fetch your App ID by selecting the app you choose to use from https://manage-sandbox.gocardless.com/developers/partners and copying the APP ID from the details ``` gocardless login [flags] ``` ### Examples ``` # authorise against the Gocardless CLI gocardless login # authorise against a partner app by providing the App ID gocardless login --app ``` ### Options ``` -a, --app string App id to authorize merchant against -h, --help help for login ``` ### Options inherited from parent commands ``` --config string config file (default is $HOME/.gc-cli/config.json) ``` --- ## gocardless open Opens GoCardless web pages on browser ### Synopsis The open command acts as a shortcut to access GoCardless pages quickly in your browser. For example: To see all shortcuts available run 'gocardless open --list' ``` gocardless open [flags] ``` ### Examples ``` gocardless open --list gocardless open api gocardless open docs gocardless open customers gocardless open dashboard/webhooks ``` ### Options ``` -h, --help help for open --list List all supported short cuts ``` ### Options inherited from parent commands ``` --config string config file (default is $HOME/.gc-cli/config.json) ``` --- ## gocardless trigger billing_request_fulfilled_payment_failed Trigger a billing request fulfilled payment failed event ### Synopsis This will trigger a billing request fulfilled payment failed event ``` gocardless trigger billing_request_fulfilled_payment_failed [args] [flags] ``` ### Examples ``` gocardless trigger billing_request_fulfilled_payment_failed ``` ### Options ``` -h, --help help for billing_request_fulfilled_payment_failed ``` ### Options inherited from parent commands ``` --billing_request string A billing request resource --config string config file (default is $HOME/.gc-cli/config.json) --customer string A customer resource --mandate string A mandate resource --payment string A payment resource ``` --- ## gocardless trigger billing_request_fulfilled_payment_paid_out Trigger a billing request fulfilled payment paid out event ### Synopsis This will trigger a billing request fulfilled payment paid out event ``` gocardless trigger billing_request_fulfilled_payment_paid_out [args] [flags] ``` ### Examples ``` gocardless trigger billing_request_fulfilled_payment_paid_out ``` ### Options ``` -h, --help help for billing_request_fulfilled_payment_paid_out ``` ### Options inherited from parent commands ``` --billing_request string A billing request resource --config string config file (default is $HOME/.gc-cli/config.json) --customer string A customer resource --mandate string A mandate resource --payment string A payment resource ``` --- ## gocardless trigger billing_request_fulfilled Trigger a billing request fulfilled event ### Synopsis This will trigger a billing request fulfilled event ``` gocardless trigger billing_request_fulfilled [args] [flags] ``` ### Examples ``` gocardless trigger billing_request_fulfilled ``` ### Options ``` -h, --help help for billing_request_fulfilled ``` ### Options inherited from parent commands ``` --billing_request string A billing request resource --config string config file (default is $HOME/.gc-cli/config.json) --customer string A customer resource --mandate string A mandate resource --payment string A payment resource ``` --- ## gocardless trigger billing_request_pending Trigger a billing request pending event ### Synopsis This will trigger a billing request pending event ``` gocardless trigger billing_request_pending [args] [flags] ``` ### Examples ``` gocardless trigger billing_request_pending ``` ### Options ``` -h, --help help for billing_request_pending ``` ### Options inherited from parent commands ``` --billing_request string A billing request resource --config string config file (default is $HOME/.gc-cli/config.json) --customer string A customer resource --mandate string A mandate resource --payment string A payment resource ``` --- ## gocardless trigger mandate_activated Trigger a mandate activated event ### Synopsis This will trigger a mandate activated event ``` gocardless trigger mandate_activated [args] [flags] ``` ### Examples ``` gocardless trigger mandate_activated ``` ### Options ``` -h, --help help for mandate_activated ``` ### Options inherited from parent commands ``` --billing_request string A billing request resource --config string config file (default is $HOME/.gc-cli/config.json) --customer string A customer resource --mandate string A mandate resource --payment string A payment resource ``` --- ## gocardless trigger mandate_expired Trigger a mandate expired event ### Synopsis This will trigger a mandate expired event ``` gocardless trigger mandate_expired [args] [flags] ``` ### Examples ``` gocardless trigger mandate_expired ``` ### Options ``` -h, --help help for mandate_expired ``` ### Options inherited from parent commands ``` --billing_request string A billing request resource --config string config file (default is $HOME/.gc-cli/config.json) --customer string A customer resource --mandate string A mandate resource --payment string A payment resource ``` --- ## gocardless trigger mandate_failed Trigger a mandate failed event ### Synopsis This will trigger a mandate failed event ``` gocardless trigger mandate_failed [args] [flags] ``` ### Examples ``` gocardless trigger mandate_failed ``` ### Options ``` -h, --help help for mandate_failed ``` ### Options inherited from parent commands ``` --billing_request string A billing request resource --config string config file (default is $HOME/.gc-cli/config.json) --customer string A customer resource --mandate string A mandate resource --payment string A payment resource ``` --- ## gocardless trigger mandate_pending_submission Trigger a mandate pending submission event ### Synopsis This will trigger a mandate pending submission event ``` gocardless trigger mandate_pending_submission [args] [flags] ``` ### Examples ``` gocardless trigger mandate_pending_submission ``` ### Options ``` -h, --help help for mandate_pending_submission ``` ### Options inherited from parent commands ``` --billing_request string A billing request resource --config string config file (default is $HOME/.gc-cli/config.json) --customer string A customer resource --mandate string A mandate resource --payment string A payment resource ``` --- ## gocardless trigger mandate_transferred Trigger a mandate transferred event ### Synopsis This will trigger a mandate transferred event ``` gocardless trigger mandate_transferred [args] [flags] ``` ### Examples ``` gocardless trigger mandate_transferred ``` ### Options ``` -h, --help help for mandate_transferred ``` ### Options inherited from parent commands ``` --billing_request string A billing request resource --config string config file (default is $HOME/.gc-cli/config.json) --customer string A customer resource --mandate string A mandate resource --payment string A payment resource ``` --- ## gocardless trigger payment_chargeback_settled Trigger a payment chargeback settled event ### Synopsis This will trigger a payment chargeback settled event ``` gocardless trigger payment_chargeback_settled [args] [flags] ``` ### Examples ``` gocardless trigger payment_chargeback_settled ``` ### Options ``` -h, --help help for payment_chargeback_settled ``` ### Options inherited from parent commands ``` --billing_request string A billing request resource --config string config file (default is $HOME/.gc-cli/config.json) --customer string A customer resource --mandate string A mandate resource --payment string A payment resource ``` --- ## gocardless trigger payment_charged_back Trigger a payment charged back event ### Synopsis This will trigger a payment charged back event ``` gocardless trigger payment_charged_back [args] [flags] ``` ### Examples ``` gocardless trigger payment_charged_back ``` ### Options ``` -h, --help help for payment_charged_back ``` ### Options inherited from parent commands ``` --billing_request string A billing request resource --config string config file (default is $HOME/.gc-cli/config.json) --customer string A customer resource --mandate string A mandate resource --payment string A payment resource ``` --- ## gocardless trigger payment_confirmed Trigger a payment confirmed event ### Synopsis This will trigger a payment confirmed event ``` gocardless trigger payment_confirmed [args] [flags] ``` ### Examples ``` gocardless trigger payment_confirmed ``` ### Options ``` -h, --help help for payment_confirmed ``` ### Options inherited from parent commands ``` --billing_request string A billing request resource --config string config file (default is $HOME/.gc-cli/config.json) --customer string A customer resource --mandate string A mandate resource --payment string A payment resource ``` --- ## gocardless trigger payment_failed Trigger a payment failed event ### Synopsis This will trigger a payment failed event ``` gocardless trigger payment_failed [args] [flags] ``` ### Examples ``` gocardless trigger payment_failed ``` ### Options ``` -h, --help help for payment_failed ``` ### Options inherited from parent commands ``` --billing_request string A billing request resource --config string config file (default is $HOME/.gc-cli/config.json) --customer string A customer resource --mandate string A mandate resource --payment string A payment resource ``` --- ## gocardless trigger payment_paid_out Trigger a payment paid out event ### Synopsis This will trigger a payment paid out event ``` gocardless trigger payment_paid_out [args] [flags] ``` ### Examples ``` gocardless trigger payment_paid_out ``` ### Options ``` -h, --help help for payment_paid_out ``` ### Options inherited from parent commands ``` --billing_request string A billing request resource --config string config file (default is $HOME/.gc-cli/config.json) --customer string A customer resource --mandate string A mandate resource --payment string A payment resource ``` --- ## gocardless trigger payment_pending_submission Trigger a payment pending submission event ### Synopsis This will trigger a payment pending submission event ``` gocardless trigger payment_pending_submission [args] [flags] ``` ### Examples ``` gocardless trigger payment_pending_submission ``` ### Options ``` -h, --help help for payment_pending_submission ``` ### Options inherited from parent commands ``` --billing_request string A billing request resource --config string config file (default is $HOME/.gc-cli/config.json) --customer string A customer resource --mandate string A mandate resource --payment string A payment resource ``` --- ## gocardless trigger payment_submitted Trigger a payment submitted event ### Synopsis This will trigger a payment submitted event ``` gocardless trigger payment_submitted [args] [flags] ``` ### Examples ``` gocardless trigger payment_submitted ``` ### Options ``` -h, --help help for payment_submitted ``` ### Options inherited from parent commands ``` --billing_request string A billing request resource --config string config file (default is $HOME/.gc-cli/config.json) --customer string A customer resource --mandate string A mandate resource --payment string A payment resource ``` --- ## gocardless trigger Trigger an event ### Synopsis Trigger a specific event. Events triggered with this command will create all othernecessary webhooks and objects required to successfully create the triggered event. You can provide a resource id along with this event if you choose to limit how many objects are autogenerated. This way the provided resource can be used in the trigger process without a new one having to be created ### Examples ``` # trigger a mandate_activated event without params - this autogenerates all objects required for mandate activation gocardless trigger mandate_activated # trigger a mandate activated event with a customer id - this triggers a mandate activated event for the specified customer gocardless trigger mandate_activated customer=customer_id # trigger a payment_confirmed event with a mandate id - this triggers a payment confirmed event for the specified mandate gocardless trigger payment_confirmed mandate=MA00192829 ``` ### Options ``` --billing_request string A billing request resource --customer string A customer resource -h, --help help for trigger --mandate string A mandate resource --payment string A payment resource ``` ### Options inherited from parent commands ``` --config string config file (default is $HOME/.gc-cli/config.json) ``` --- ## gocardless update updates the requested resource ### Synopsis This will call the update api for the requested resource and updates it in GoCardless This command uses the `--data` (or `-d`) flag to construct the data payload for the request. Otherwise you can use `--editorName vim`, then you can enter json and exit to submit. See a list of possible resources from the GoCardless API Reference: /docs/api-reference#core-endpoints ``` gocardless update [flags] ``` ### Examples ``` # update a subscription's name. gocardless update subscription SB1234 -d name=SUB # update a subscription with editor # opens vim prompt and then you can enter json data. gocardless update subscription SB1234 --editorName vim ``` ### Options ``` -d, --data stringArray Data for the API request --editorName string Pass an editor to read data from. -h, --help help for update ``` ### Options inherited from parent commands ``` --config string config file (default is $HOME/.gc-cli/config.json) ``` --- ## gocardless version Print version of CLI ``` gocardless version [flags] ``` ### Examples ``` gocardless version ``` ### Options ``` -h, --help help for version ``` ### Options inherited from parent commands ``` --config string config file (default is $HOME/.gc-cli/config.json) ```