# GoCardless

> Collect Direct Debit payments with GoCardless: create customers and bank accounts, set up mandates, collect one-off payments, run subscriptions and instalment plans, and follow what happens to each payment.

App · 30 actions. Web page: https://docs.lodol.com/docs/integrations/gocardless

## Actions

### Add bank account

Add a bank account to a customer, from an IBAN, or an account number with a sort code or routing number. Only add details the customer gave you permission to use.

**Inputs**

- Customer (`customer_id`, text, required): The customer. Pick one, or give its ID (starts with CU) from an earlier step.
- Account holder name (`account_holder_name`, text, required): The name on the account.
- Country code (`country_code`, text): The bank's two-letter country code, such as GB. Needed with an account number.
- IBAN (`iban`, text): The IBAN. Use this or an account number, not both.
- Account number (`account_number`, text): The local account number. Use this or an IBAN.
- Sort code or routing number (`branch_code`, text): The sort code (UK), routing number (US) or branch code, without dashes.
- Bank code (`bank_code`, text): The bank code, for countries that use one.
- Account type (`account_type`, text): Checking or savings, for US and Canadian accounts. One of: `checking`, `savings`.
- Currency (`currency`, text): The account's currency, when GoCardless can't tell from the country. One of: `GBP` (GBP - British pound), `EUR` (EUR - Euro), `USD` (USD - US dollar), `SEK` (SEK - Swedish krona), `DKK` (DKK - Danish krone), `AUD` (AUD - Australian dollar), `NZD` (NZD - New Zealand dollar), `CAD` (CAD - Canadian dollar).
- Metadata (`metadata`, object): Your own notes to keep on the record, as keys and values. GoCardless allows up to 3 keys.

**Outputs**

- `bank_account` (object): The new bank account

**Example output**

```json
{
  "bank_account": {
    "account_holder_name": "JO BLOGGS",
    "account_number_ending": "11",
    "account_type": null,
    "bank_name": "BARCLAYS BANK PLC",
    "country_code": "GB",
    "created_at": "2026-11-13T19:02:39.075Z",
    "currency": "GBP",
    "enabled": true,
    "id": "BA0123456789",
    "links": {
      "customer": "CU0123456789"
    },
    "metadata": {}
  }
}
```

### Cancel instalment schedule

Cancel an instalment schedule and its payments not yet submitted. A new schedule is pending for a few seconds: cancel it once it is active.

**Inputs**

- Instalment schedule (`instalment_schedule_id`, text, required): The schedule's ID (starts with IS), from 'Create instalment schedule'.

**Outputs**

- `instalment_schedule` (object): The cancelled schedule

**Example output**

```json
{
  "instalment_schedule": {
    "created_at": "2026-11-13T19:02:59.341Z",
    "currency": "GBP",
    "id": "IS0123456789",
    "links": {
      "customer": "CU0123456789",
      "mandate": "MD0123456789",
      "payments": [
        "PM0123456789"
      ]
    },
    "metadata": {},
    "name": "Three payments",
    "payment_errors": {},
    "status": "cancelled",
    "total_amount": 600
  }
}
```

### Cancel mandate

Cancel a mandate. Its subscriptions and payments not yet submitted are cancelled too.

**Inputs**

- Mandate (`mandate_id`, text, required): The mandate. Pick one, or give its ID (starts with MD) from an earlier step.

**Outputs**

- `mandate` (object): The cancelled mandate

**Example output**

```json
{
  "mandate": {
    "created_at": "2026-11-13T19:02:43.514Z",
    "id": "MD0123456789",
    "links": {
      "creditor": "CR0123456789",
      "customer": "CU0123456789",
      "customer_bank_account": "BA0123456789"
    },
    "metadata": {},
    "next_possible_charge_date": "2026-11-20",
    "payments_require_approval": false,
    "reference": "EXAMPLE-83VM66AZ",
    "scheme": "bacs",
    "status": "cancelled"
  }
}
```

### Cancel payment

Cancel a payment that has not yet been submitted to the bank.

**Inputs**

- Payment (`payment_id`, text, required): The payment. Pick one, or give its ID (starts with PM) from an earlier step.

**Outputs**

- `payment` (object): The cancelled payment

**Example output**

```json
{
  "payment": {
    "amount": 1050,
    "amount_refunded": 0,
    "charge_date": "2026-11-20",
    "created_at": "2026-11-13T19:02:50.632Z",
    "currency": "GBP",
    "description": "Invoice 1042",
    "id": "PM0123456789",
    "links": {
      "creditor": "CR0123456789",
      "mandate": "MD0123456789"
    },
    "metadata": {},
    "reference": null,
    "retry_if_possible": false,
    "scheme": "bacs",
    "status": "cancelled"
  }
}
```

### Cancel subscription

Cancel a subscription so no more payments are created. Payments already created are not cancelled.

**Inputs**

- Subscription (`subscription_id`, text, required): The subscription. Pick one, or give its ID (starts with SB) from an earlier step.

**Outputs**

- `subscription` (object): The cancelled subscription

**Example output**

```json
{
  "subscription": {
    "amount": 500,
    "count": null,
    "created_at": "2026-11-13T19:02:51.064Z",
    "currency": "GBP",
    "day_of_month": null,
    "end_date": null,
    "id": "SB0123456789",
    "interval": 1,
    "interval_unit": "monthly",
    "links": {
      "mandate": "MD0123456789"
    },
    "metadata": {},
    "month": null,
    "name": "Monthly plan",
    "payment_reference": null,
    "retry_if_possible": false,
    "start_date": "2026-11-20",
    "status": "cancelled",
    "upcoming_payments": [
      {
        "amount": 500,
        "charge_date": "2026-11-20"
      }
    ]
  }
}
```

### Create customer

Create a customer to collect Direct Debits from. Give their email and a first and last name, or a company name.

**Inputs**

- Email (`email`, text, required): The customer's email address.
- First name (`given_name`, text): The customer's first name.
- Last name (`family_name`, text): The customer's last name.
- Company name (`company_name`, text): The company, instead of a first and last name.
- Phone (`phone_number`, text): Their phone number with the country code, like +447700900123.
- Address line 1 (`address_line1`, text): The first line of their address.
- Address line 2 (`address_line2`, text): The second line of their address.
- Address line 3 (`address_line3`, text): The third line of their address.
- City (`city`, text): Their town or city.
- Region (`region`, text): Their county, state or region.
- Postcode (`postal_code`, text): Their postcode or ZIP code.
- Country code (`country_code`, text): Their two-letter country code, such as GB, US or DE.
- Language (`language`, text): The language of the emails GoCardless sends them, such as en or fr.
- Metadata (`metadata`, object): Your own notes to keep on the record, as keys and values. GoCardless allows up to 3 keys.

**Outputs**

- `customer` (object): The new customer

**Example output**

```json
{
  "customer": {
    "address_line1": "1 Test Street",
    "address_line2": null,
    "address_line3": null,
    "city": "London",
    "company_name": null,
    "country_code": "GB",
    "created_at": "2026-11-13T19:02:34.598Z",
    "email": "jo@example.com",
    "family_name": "Bloggs",
    "given_name": "Jo",
    "id": "CU0123456789",
    "language": "en",
    "metadata": {},
    "phone_number": null,
    "postal_code": "EC1V 7EN",
    "region": null
  }
}
```

### Create instalment schedule

Split a total amount into equal payments on a schedule, such as 100.00 in 4 monthly payments. Any odd pennies go on the last payment.

**Inputs**

- Mandate (`mandate_id`, text, required): The mandate. Pick one, or give its ID (starts with MD) from an earlier step.
- Total amount (`total_amount`, number, required): The whole amount to collect, in the currency's main unit, such as 100.00. At least 0.01.
- Currency (`currency`, text, required): The currency. It must match the mandate's scheme (GBP for Bacs, EUR for SEPA). One of: `GBP` (GBP - British pound), `EUR` (EUR - Euro), `USD` (USD - US dollar), `SEK` (SEK - Swedish krona), `DKK` (DKK - Danish krone), `AUD` (AUD - Australian dollar), `NZD` (NZD - New Zealand dollar), `CAD` (CAD - Canadian dollar).
- Number of payments (`number_of_payments`, number, required): How many equal payments to split it into, 1 to 100. From 1 to 100.
- Repeats (`interval_unit`, text, required): How often to collect. One of: `monthly`, `weekly`, `yearly`.
- First payment on (`start_date`, date): The day of the first payment. Leave empty for the earliest possible day.
- Every (`interval`, number): Collect every this many weeks, months or years. Defaults to 1. From 1 to 1000.
- Name (`name`, text): A name for the schedule, such as Annual fee in four parts.
- Metadata (`metadata`, object): Your own notes to keep on the record, as keys and values. GoCardless allows up to 3 keys.

**Outputs**

- `instalment_schedule` (object): The new schedule

**Example output**

```json
{
  "instalment_schedule": {
    "created_at": "2026-11-13T19:02:59.341Z",
    "currency": "GBP",
    "id": "IS0123456789",
    "links": {
      "customer": "CU0123456789",
      "mandate": "MD0123456789",
      "payments": [
        "PM0123456789"
      ]
    },
    "metadata": {},
    "name": "Three payments",
    "payment_errors": {},
    "status": "pending",
    "total_amount": 600
  }
}
```

### Create mandate

Set up a mandate on a customer's bank account, which lets you collect payments from it. Only do this for a customer who has authorised you to collect.

**Inputs**

- Bank account (`bank_account_id`, text, required): The customer's bank account. Pick one, or give its ID (starts with BA).
- Scheme (`scheme`, text): The Direct Debit scheme. Leave empty to use the bank account's. One of: `bacs` (Bacs Direct Debit (UK)), `sepa_core` (SEPA Core Direct Debit (Eurozone)), `ach` (ACH (US)), `autogiro` (Autogiro (Sweden)), `becs` (BECS (Australia)), `becs_nz` (BECS NZ (New Zealand)), `betalingsservice` (Betalingsservice (Denmark)), `pad` (PAD (Canada)), `pay_to` (PayTo (Australia)).
- Creditor (`creditor_id`, text): The creditor collecting. Only needed when the account has more than one.
- Reference (`reference`, text): The reference on the customer's bank statement, where the scheme lets you choose it.
- Metadata (`metadata`, object): Your own notes to keep on the record, as keys and values. GoCardless allows up to 3 keys.

**Outputs**

- `mandate` (object): The new mandate

**Example output**

```json
{
  "mandate": {
    "created_at": "2026-11-13T19:02:43.514Z",
    "id": "MD0123456789",
    "links": {
      "creditor": "CR0123456789",
      "customer": "CU0123456789",
      "customer_bank_account": "BA0123456789"
    },
    "metadata": {},
    "next_possible_charge_date": "2026-11-20",
    "payments_require_approval": false,
    "reference": "EXAMPLE-83VM66AZ",
    "scheme": "bacs",
    "status": "pending_submission"
  }
}
```

### Create payment

Collect a one-off payment from a mandate. Write the amount as you would, such as 10.50. Only collect what the customer agreed to.

**Inputs**

- Mandate (`mandate_id`, text, required): The mandate. Pick one, or give its ID (starts with MD) from an earlier step.
- Amount (`amount`, number, required): How much to collect, in the currency's main unit, such as 10.50. At least 0.01.
- Currency (`currency`, text, required): The currency. It must match the mandate's scheme (GBP for Bacs, EUR for SEPA). One of: `GBP` (GBP - British pound), `EUR` (EUR - Euro), `USD` (USD - US dollar), `SEK` (SEK - Swedish krona), `DKK` (DKK - Danish krone), `AUD` (AUD - Australian dollar), `NZD` (NZD - New Zealand dollar), `CAD` (CAD - Canadian dollar).
- Description (`description`, text): What the payment is for, shown to the customer. Up to 140 characters.
- Charge date (`charge_date`, date): The day to collect. Leave empty for the earliest possible day.
- Reference (`reference`, text): The reference on the customer's statement, where the scheme lets you choose it.
- Retry if it fails (`retry_if_possible`, true/false): Turn on to have GoCardless retry the payment if it fails (where supported).
- Metadata (`metadata`, object): Your own notes to keep on the record, as keys and values. GoCardless allows up to 3 keys.

**Outputs**

- `payment` (object): The new payment

**Example output**

```json
{
  "payment": {
    "amount": 1050,
    "amount_refunded": 0,
    "charge_date": "2026-11-20",
    "created_at": "2026-11-13T19:02:50.632Z",
    "currency": "GBP",
    "description": "Invoice 1042",
    "id": "PM0123456789",
    "links": {
      "creditor": "CR0123456789",
      "mandate": "MD0123456789"
    },
    "metadata": {},
    "reference": null,
    "retry_if_possible": false,
    "scheme": "bacs",
    "status": "pending_submission"
  }
}
```

### Create subscription

Collect an amount on a repeating schedule from a mandate. Write the amount as you would, such as 5.00.

**Inputs**

- Mandate (`mandate_id`, text, required): The mandate. Pick one, or give its ID (starts with MD) from an earlier step.
- Amount (`amount`, number, required): How much to collect each time, in the currency's main unit, such as 5.00. At least 0.01.
- Currency (`currency`, text, required): The currency. It must match the mandate's scheme (GBP for Bacs, EUR for SEPA). One of: `GBP` (GBP - British pound), `EUR` (EUR - Euro), `USD` (USD - US dollar), `SEK` (SEK - Swedish krona), `DKK` (DKK - Danish krone), `AUD` (AUD - Australian dollar), `NZD` (NZD - New Zealand dollar), `CAD` (CAD - Canadian dollar).
- Repeats (`interval_unit`, text, required): How often to collect. One of: `monthly`, `weekly`, `yearly`.
- Every (`interval`, number): Collect every this many weeks, months or years. Defaults to 1. From 1 to 1000.
- Name (`name`, text): A name for the subscription, such as Monthly plan.
- First payment on (`start_date`, date): The day of the first payment. Leave empty for the earliest possible day.
- Last payment by (`end_date`, date): Stop after this day. Use this or a number of payments.
- Number of payments (`count`, number): Stop after this many payments. Use this or a last day. At least 1.
- Day of the month (`day_of_month`, number): For monthly or yearly: 1 to 28, or -1 for the last day of the month. From -1 to 28.
- Month (`month`, text): For yearly: the month to collect in. One of: `january`, `february`, `march`, `april`, `may`, `june`, `july`, `august`, `september`, `october`, `november`, `december`.
- Payment reference (`payment_reference`, text): The reference on each payment, where the scheme lets you choose it.
- Retry if a payment fails (`retry_if_possible`, true/false): Turn on to have GoCardless retry failed payments (where supported).
- Metadata (`metadata`, object): Your own notes to keep on the record, as keys and values. GoCardless allows up to 3 keys.

**Outputs**

- `subscription` (object): The new subscription

**Example output**

```json
{
  "subscription": {
    "amount": 500,
    "count": null,
    "created_at": "2026-11-13T19:02:51.064Z",
    "currency": "GBP",
    "day_of_month": null,
    "end_date": null,
    "id": "SB0123456789",
    "interval": 1,
    "interval_unit": "monthly",
    "links": {
      "mandate": "MD0123456789"
    },
    "metadata": {},
    "month": null,
    "name": "Monthly plan",
    "payment_reference": null,
    "retry_if_possible": false,
    "start_date": "2026-11-20",
    "status": "active",
    "upcoming_payments": [
      {
        "amount": 500,
        "charge_date": "2026-11-20"
      }
    ]
  }
}
```

### Disable bank account

Disable a customer's bank account. Its mandates are cancelled and it can't be used again.

**Inputs**

- Bank account (`bank_account_id`, text, required): The customer's bank account. Pick one, or give its ID (starts with BA).

**Outputs**

- `bank_account` (object): The disabled bank account

**Example output**

```json
{
  "bank_account": {
    "account_holder_name": "JO BLOGGS",
    "account_number_ending": "11",
    "account_type": null,
    "bank_name": "BARCLAYS BANK PLC",
    "country_code": "GB",
    "created_at": "2026-11-13T19:02:39.075Z",
    "currency": "GBP",
    "enabled": false,
    "id": "BA0123456789",
    "links": {
      "customer": "CU0123456789"
    },
    "metadata": {}
  }
}
```

### Get customer

Get one customer with their contact details and address.

**Inputs**

- Customer (`customer_id`, text, required): The customer. Pick one, or give its ID (starts with CU) from an earlier step.

**Outputs**

- `customer` (object): The customer

**Example output**

```json
{
  "customer": {
    "address_line1": "1 Test Street",
    "address_line2": null,
    "address_line3": null,
    "city": "London",
    "company_name": null,
    "country_code": "GB",
    "created_at": "2026-11-13T19:02:34.598Z",
    "email": "jo@example.com",
    "family_name": "Bloggs",
    "given_name": "Jo",
    "id": "CU0123456789",
    "language": "en",
    "metadata": {},
    "phone_number": null,
    "postal_code": "EC1V 7EN",
    "region": null
  }
}
```

### Get event

Get one event with its cause, description and the records it concerns.

**Inputs**

- Event (`event_id`, text, required): The event's ID (starts with EV), from 'List events' or a trigger.

**Outputs**

- `event` (object): The event

**Example output**

```json
{
  "event": {
    "action": "cancelled",
    "created_at": "2026-11-13T19:03:16.040Z",
    "details": {
      "cause": "mandate_cancelled",
      "description": "The mandate was cancelled at your request.",
      "origin": "api"
    },
    "id": "EV0123456789",
    "links": {
      "mandate": "MD0123456789"
    },
    "metadata": {},
    "resource_type": "mandates"
  }
}
```

### Get instalment schedule

Get one instalment schedule with its status and the payments it created.

**Inputs**

- Instalment schedule (`instalment_schedule_id`, text, required): The schedule's ID (starts with IS), from 'Create instalment schedule'.

**Outputs**

- `instalment_schedule` (object): The schedule

**Example output**

```json
{
  "instalment_schedule": {
    "created_at": "2026-11-13T19:02:59.341Z",
    "currency": "GBP",
    "id": "IS0123456789",
    "links": {
      "customer": "CU0123456789",
      "mandate": "MD0123456789",
      "payments": [
        "PM0123456789"
      ]
    },
    "metadata": {},
    "name": "Three payments",
    "payment_errors": {},
    "status": "pending",
    "total_amount": 600
  }
}
```

### Get mandate

Get one mandate with its status, scheme and the next date a payment can be collected.

**Inputs**

- Mandate (`mandate_id`, text, required): The mandate. Pick one, or give its ID (starts with MD) from an earlier step.

**Outputs**

- `mandate` (object): The mandate

**Example output**

```json
{
  "mandate": {
    "created_at": "2026-11-13T19:02:43.514Z",
    "id": "MD0123456789",
    "links": {
      "creditor": "CR0123456789",
      "customer": "CU0123456789",
      "customer_bank_account": "BA0123456789"
    },
    "metadata": {},
    "next_possible_charge_date": "2026-11-20",
    "payments_require_approval": false,
    "reference": "EXAMPLE-83VM66AZ",
    "scheme": "bacs",
    "status": "pending_submission"
  }
}
```

### Get payment

Get one payment with its status, charge date and amount (in pence or cents).

**Inputs**

- Payment (`payment_id`, text, required): The payment. Pick one, or give its ID (starts with PM) from an earlier step.

**Outputs**

- `payment` (object): The payment

**Example output**

```json
{
  "payment": {
    "amount": 1050,
    "amount_refunded": 0,
    "charge_date": "2026-11-20",
    "created_at": "2026-11-13T19:02:50.632Z",
    "currency": "GBP",
    "description": "Invoice 1042",
    "id": "PM0123456789",
    "links": {
      "creditor": "CR0123456789",
      "mandate": "MD0123456789"
    },
    "metadata": {},
    "reference": null,
    "retry_if_possible": false,
    "scheme": "bacs",
    "status": "pending_submission"
  }
}
```

### Get subscription

Get one subscription with its schedule and its next payments.

**Inputs**

- Subscription (`subscription_id`, text, required): The subscription. Pick one, or give its ID (starts with SB) from an earlier step.

**Outputs**

- `subscription` (object): The subscription

**Example output**

```json
{
  "subscription": {
    "amount": 500,
    "count": null,
    "created_at": "2026-11-13T19:02:51.064Z",
    "currency": "GBP",
    "day_of_month": null,
    "end_date": null,
    "id": "SB0123456789",
    "interval": 1,
    "interval_unit": "monthly",
    "links": {
      "mandate": "MD0123456789"
    },
    "metadata": {},
    "month": null,
    "name": "Monthly plan",
    "payment_reference": null,
    "retry_if_possible": false,
    "start_date": "2026-11-20",
    "status": "active",
    "upcoming_payments": [
      {
        "amount": 500,
        "charge_date": "2026-11-20"
      }
    ]
  }
}
```

### List bank accounts

List customers' bank accounts, optionally one customer's.

**Inputs**

- Customer (`customer_id`, text): Only this customer's. Pick one, or give its ID from an earlier step.
- Only enabled (`enabled`, true/false): Turn on to leave out disabled accounts.
- Page size (`limit`, number): How many to return, 1 to 500. GoCardless's default is 50. From 1 to 500.
- Next page cursor (`after`, text): The 'next_cursor' from an earlier page, to get the page after it.
- Previous page cursor (`before`, text): The 'previous_cursor' from an earlier page, to get the page before it.

**Outputs**

- `count` (number): How many are in this page
- `customer_bank_accounts` (list): The bank accounts
- `next_cursor` (text): Pass as 'Next page cursor' for the next page; empty on the last
- `previous_cursor` (text): Pass as 'Previous page cursor' for the page before; empty on the first

**Example output**

```json
{
  "count": 1,
  "customer_bank_accounts": [
    {
      "account_holder_name": "JO BLOGGS",
      "account_number_ending": "11",
      "account_type": null,
      "bank_name": "BARCLAYS BANK PLC",
      "country_code": "GB",
      "created_at": "2026-11-13T19:02:39.075Z",
      "currency": "GBP",
      "enabled": true,
      "id": "BA0123456789",
      "links": {
        "customer": "CU0123456789"
      },
      "metadata": {}
    }
  ],
  "next_cursor": "",
  "previous_cursor": ""
}
```

### List creditors

List the creditors (the businesses that collect money) on the account, with their Direct Debit schemes.

**Inputs**

- Page size (`limit`, number): How many to return, 1 to 500. GoCardless's default is 50. From 1 to 500.
- Next page cursor (`after`, text): The 'next_cursor' from an earlier page, to get the page after it.
- Previous page cursor (`before`, text): The 'previous_cursor' from an earlier page, to get the page before it.

**Outputs**

- `count` (number): How many are in this page
- `creditors` (list): The creditors
- `next_cursor` (text): Pass as 'Next page cursor' for the next page; empty on the last
- `previous_cursor` (text): Pass as 'Previous page cursor' for the page before; empty on the first

**Example output**

```json
{
  "count": 1,
  "creditors": [
    {
      "address_line1": "1 Test Street",
      "city": "London",
      "country_code": "GB",
      "created_at": "2026-11-13T18:20:04.375Z",
      "creditor_type": "company",
      "id": "CR0123456789",
      "name": "Example Ltd",
      "postal_code": "EC1V 7EN",
      "scheme_identifiers": [
        {
          "currency": "GBP",
          "scheme": "bacs",
          "status": "active"
        }
      ]
    }
  ],
  "next_cursor": "",
  "previous_cursor": ""
}
```

### List customers

List customers, newest first, optionally those created between two dates.

**Inputs**

- Created on or after (`created_from`, date): Only records created on or after this day.
- Created on or before (`created_until`, date): Only records created on or before this day.
- Order (`direction`, text): Sort by when they were created. Defaults to newest first. One of: `desc` (Newest first (default)), `asc` (Oldest first).
- Page size (`limit`, number): How many to return, 1 to 500. GoCardless's default is 50. From 1 to 500.
- Next page cursor (`after`, text): The 'next_cursor' from an earlier page, to get the page after it.
- Previous page cursor (`before`, text): The 'previous_cursor' from an earlier page, to get the page before it.

**Outputs**

- `count` (number): How many are in this page
- `customers` (list): The customers
- `next_cursor` (text): Pass as 'Next page cursor' for the next page; empty on the last
- `previous_cursor` (text): Pass as 'Previous page cursor' for the page before; empty on the first

**Example output**

```json
{
  "count": 1,
  "customers": [
    {
      "address_line1": "1 Test Street",
      "address_line2": null,
      "address_line3": null,
      "city": "London",
      "company_name": null,
      "country_code": "GB",
      "created_at": "2026-11-13T19:02:34.598Z",
      "email": "jo@example.com",
      "family_name": "Bloggs",
      "given_name": "Jo",
      "id": "CU0123456789",
      "language": "en",
      "metadata": {},
      "phone_number": null,
      "postal_code": "EC1V 7EN",
      "region": null
    }
  ],
  "next_cursor": "",
  "previous_cursor": ""
}
```

### List events

List what happened to payments, mandates, subscriptions and the rest, newest first, such as a payment being confirmed or failing.

**Inputs**

- About (`resource_type`, text): Only events about this kind of record. Can't be combined with a mandate, payment or subscription. One of: `payments`, `mandates`, `subscriptions`, `payouts`, `refunds`, `instalment_schedules` (Instalment schedules), `billing_requests` (Billing requests), `creditors`.
- Event (`event_action`, text): Only this event, such as confirmed, failed, paid_out or cancelled. Needs a kind of record, or a mandate, payment or subscription.
- Mandate (`mandate_id`, text): Only this mandate's. Pick one, or give its ID from an earlier step.
- Payment (`payment_id`, text): Only this payment's events. Pick one, or give its ID.
- Subscription (`subscription_id`, text): Only this subscription's. Pick one, or give its ID from an earlier step.
- Created on or after (`created_from`, date): Only records created on or after this day.
- Created on or before (`created_until`, date): Only records created on or before this day.
- Page size (`limit`, number): How many to return, 1 to 500. GoCardless's default is 50. From 1 to 500.
- Next page cursor (`after`, text): The 'next_cursor' from an earlier page, to get the page after it.
- Previous page cursor (`before`, text): The 'previous_cursor' from an earlier page, to get the page before it.

**Outputs**

- `count` (number): How many are in this page
- `events` (list): The events
- `next_cursor` (text): Pass as 'Next page cursor' for the next page; empty on the last
- `previous_cursor` (text): Pass as 'Previous page cursor' for the page before; empty on the first

**Example output**

```json
{
  "count": 1,
  "events": [
    {
      "action": "cancelled",
      "created_at": "2026-11-13T19:03:16.040Z",
      "details": {
        "cause": "mandate_cancelled",
        "description": "The mandate was cancelled at your request.",
        "origin": "api"
      },
      "id": "EV0123456789",
      "links": {
        "mandate": "MD0123456789"
      },
      "metadata": {},
      "resource_type": "mandates"
    }
  ],
  "next_cursor": "",
  "previous_cursor": ""
}
```

### List mandates

List mandates (customers' permissions to collect), filtered by customer, status, scheme or reference.

**Inputs**

- Customer (`customer_id`, text): Only this customer's. Pick one, or give its ID from an earlier step.
- Status (`status`, text): Only mandates in this status. One of: `pending_customer_approval` (Waiting for the customer), `pending_submission` (Waiting to be submitted), `submitted` (Submitted to the bank), `active`, `failed`, `cancelled`, `expired`, `consumed` (Used up), `blocked`, `suspended_by_payer` (Suspended by the customer).
- Scheme (`scheme`, text): Only mandates on this Direct Debit scheme. One of: `bacs` (Bacs Direct Debit (UK)), `sepa_core` (SEPA Core Direct Debit (Eurozone)), `ach` (ACH (US)), `autogiro` (Autogiro (Sweden)), `becs` (BECS (Australia)), `becs_nz` (BECS NZ (New Zealand)), `betalingsservice` (Betalingsservice (Denmark)), `pad` (PAD (Canada)), `pay_to` (PayTo (Australia)).
- Reference (`reference`, text): Only the mandate with this reference.
- Created on or after (`created_from`, date): Only records created on or after this day.
- Created on or before (`created_until`, date): Only records created on or before this day.
- Page size (`limit`, number): How many to return, 1 to 500. GoCardless's default is 50. From 1 to 500.
- Next page cursor (`after`, text): The 'next_cursor' from an earlier page, to get the page after it.
- Previous page cursor (`before`, text): The 'previous_cursor' from an earlier page, to get the page before it.

**Outputs**

- `count` (number): How many are in this page
- `mandates` (list): The mandates
- `next_cursor` (text): Pass as 'Next page cursor' for the next page; empty on the last
- `previous_cursor` (text): Pass as 'Previous page cursor' for the page before; empty on the first

**Example output**

```json
{
  "count": 1,
  "mandates": [
    {
      "created_at": "2026-11-13T19:02:43.514Z",
      "id": "MD0123456789",
      "links": {
        "creditor": "CR0123456789",
        "customer": "CU0123456789",
        "customer_bank_account": "BA0123456789"
      },
      "metadata": {},
      "next_possible_charge_date": "2026-11-20",
      "payments_require_approval": false,
      "reference": "EXAMPLE-83VM66AZ",
      "scheme": "bacs",
      "status": "pending_submission"
    }
  ],
  "next_cursor": "",
  "previous_cursor": ""
}
```

### List payments

List payments, filtered by customer, mandate, subscription, status, currency and dates. Amounts in the results are in pence or cents.

**Inputs**

- Customer (`customer_id`, text): Only this customer's. Pick one, or give its ID from an earlier step.
- Mandate (`mandate_id`, text): Only this mandate's. Pick one, or give its ID from an earlier step.
- Subscription (`subscription_id`, text): Only this subscription's. Pick one, or give its ID from an earlier step.
- Status (`status`, text): Only payments in this status. One of: `pending_customer_approval` (Waiting for the customer), `pending_submission` (Waiting to be submitted), `submitted` (Submitted to the bank), `confirmed` (Collected (confirmed)), `paid_out` (Paid out to you), `cancelled`, `customer_approval_denied` (Customer refused), `failed`, `charged_back` (Charged back).
- Currency (`currency`, text): Only payments in this currency. One of: `GBP` (GBP - British pound), `EUR` (EUR - Euro), `USD` (USD - US dollar), `SEK` (SEK - Swedish krona), `DKK` (DKK - Danish krone), `AUD` (AUD - Australian dollar), `NZD` (NZD - New Zealand dollar), `CAD` (CAD - Canadian dollar).
- Charged on or after (`charge_from`, date): Only payments charged on or after this day.
- Charged on or before (`charge_until`, date): Only payments charged on or before this day.
- Created on or after (`created_from`, date): Only records created on or after this day.
- Created on or before (`created_until`, date): Only records created on or before this day.
- Page size (`limit`, number): How many to return, 1 to 500. GoCardless's default is 50. From 1 to 500.
- Next page cursor (`after`, text): The 'next_cursor' from an earlier page, to get the page after it.
- Previous page cursor (`before`, text): The 'previous_cursor' from an earlier page, to get the page before it.

**Outputs**

- `count` (number): How many are in this page
- `next_cursor` (text): Pass as 'Next page cursor' for the next page; empty on the last
- `payments` (list): The payments
- `previous_cursor` (text): Pass as 'Previous page cursor' for the page before; empty on the first

**Example output**

```json
{
  "count": 1,
  "next_cursor": "",
  "payments": [
    {
      "amount": 1050,
      "amount_refunded": 0,
      "charge_date": "2026-11-20",
      "created_at": "2026-11-13T19:02:50.632Z",
      "currency": "GBP",
      "description": "Invoice 1042",
      "id": "PM0123456789",
      "links": {
        "creditor": "CR0123456789",
        "mandate": "MD0123456789"
      },
      "metadata": {},
      "reference": null,
      "retry_if_possible": false,
      "scheme": "bacs",
      "status": "pending_submission"
    }
  ],
  "previous_cursor": ""
}
```

### List subscriptions

List subscriptions, filtered by customer, mandate and status.

**Inputs**

- Customer (`customer_id`, text): Only this customer's. Pick one, or give its ID from an earlier step.
- Mandate (`mandate_id`, text): Only this mandate's. Pick one, or give its ID from an earlier step.
- Status (`status`, text): Only subscriptions in this status. One of: `pending_customer_approval` (Waiting for the customer), `customer_approval_denied` (Customer refused), `active`, `finished`, `cancelled`, `paused`.
- Created on or after (`created_from`, date): Only records created on or after this day.
- Created on or before (`created_until`, date): Only records created on or before this day.
- Page size (`limit`, number): How many to return, 1 to 500. GoCardless's default is 50. From 1 to 500.
- Next page cursor (`after`, text): The 'next_cursor' from an earlier page, to get the page after it.
- Previous page cursor (`before`, text): The 'previous_cursor' from an earlier page, to get the page before it.

**Outputs**

- `count` (number): How many are in this page
- `next_cursor` (text): Pass as 'Next page cursor' for the next page; empty on the last
- `previous_cursor` (text): Pass as 'Previous page cursor' for the page before; empty on the first
- `subscriptions` (list): The subscriptions

**Example output**

```json
{
  "count": 1,
  "next_cursor": "",
  "previous_cursor": "",
  "subscriptions": [
    {
      "amount": 500,
      "count": null,
      "created_at": "2026-11-13T19:02:51.064Z",
      "currency": "GBP",
      "day_of_month": null,
      "end_date": null,
      "id": "SB0123456789",
      "interval": 1,
      "interval_unit": "monthly",
      "links": {
        "mandate": "MD0123456789"
      },
      "metadata": {},
      "month": null,
      "name": "Monthly plan",
      "payment_reference": null,
      "retry_if_possible": false,
      "start_date": "2026-11-20",
      "status": "active",
      "upcoming_payments": [
        {
          "amount": 500,
          "charge_date": "2026-11-20"
        }
      ]
    }
  ]
}
```

### Pause subscription

Pause a subscription for a number of payments, or until it is resumed.

**Inputs**

- Subscription (`subscription_id`, text, required): The subscription. Pick one, or give its ID (starts with SB) from an earlier step.
- Payments to skip (`pause_cycles`, number): How many payments to skip. Leave empty to pause until you resume it. From 1 to 1000.

**Outputs**

- `subscription` (object): The paused subscription

**Example output**

```json
{
  "subscription": {
    "amount": 500,
    "count": null,
    "created_at": "2026-11-13T19:02:51.064Z",
    "currency": "GBP",
    "day_of_month": null,
    "end_date": null,
    "id": "SB0123456789",
    "interval": 1,
    "interval_unit": "monthly",
    "links": {
      "mandate": "MD0123456789"
    },
    "metadata": {},
    "month": null,
    "name": "Monthly plan",
    "payment_reference": null,
    "retry_if_possible": false,
    "start_date": "2026-11-20",
    "status": "paused",
    "upcoming_payments": [
      {
        "amount": 500,
        "charge_date": "2026-11-20"
      }
    ]
  }
}
```

### Remove customer

Permanently remove a customer's personal data (GoCardless keeps payment records, anonymised). This cannot be undone.

**Inputs**

- Customer (`customer_id`, text, required): The customer. Pick one, or give its ID (starts with CU) from an earlier step.

**Outputs**

- `customer` (object): The customer as it was before
- `customer_id` (text): The customer removed
- `removed` (true/false): Always true once removed

**Example output**

```json
{
  "customer": {
    "address_line1": "1 Test Street",
    "address_line2": null,
    "address_line3": null,
    "city": "London",
    "company_name": null,
    "country_code": "GB",
    "created_at": "2026-11-13T19:02:34.598Z",
    "email": "jo@example.com",
    "family_name": "Bloggs",
    "given_name": "Jo",
    "id": "CU0123456789",
    "language": "en",
    "metadata": {},
    "phone_number": null,
    "postal_code": "EC1V 7EN",
    "region": null
  },
  "customer_id": "CU0123456789",
  "removed": true
}
```

### Resume subscription

Resume a paused subscription.

**Inputs**

- Subscription (`subscription_id`, text, required): The subscription. Pick one, or give its ID (starts with SB) from an earlier step.

**Outputs**

- `subscription` (object): The resumed subscription

**Example output**

```json
{
  "subscription": {
    "amount": 500,
    "count": null,
    "created_at": "2026-11-13T19:02:51.064Z",
    "currency": "GBP",
    "day_of_month": null,
    "end_date": null,
    "id": "SB0123456789",
    "interval": 1,
    "interval_unit": "monthly",
    "links": {
      "mandate": "MD0123456789"
    },
    "metadata": {},
    "month": null,
    "name": "Monthly plan",
    "payment_reference": null,
    "retry_if_possible": false,
    "start_date": "2026-11-20",
    "status": "active",
    "upcoming_payments": [
      {
        "amount": 500,
        "charge_date": "2026-11-20"
      }
    ]
  }
}
```

### Update customer

Change a customer's details. Only the fields you fill in change.

**Inputs**

- Customer (`customer_id`, text, required): The customer. Pick one, or give its ID (starts with CU) from an earlier step.
- Email (`email`, text): A new email address. Leave empty to keep it.
- First name (`given_name`, text): The customer's first name.
- Last name (`family_name`, text): The customer's last name.
- Company name (`company_name`, text): The company, instead of a first and last name.
- Phone (`phone_number`, text): Their phone number with the country code, like +447700900123.
- Address line 1 (`address_line1`, text): The first line of their address.
- Address line 2 (`address_line2`, text): The second line of their address.
- Address line 3 (`address_line3`, text): The third line of their address.
- City (`city`, text): Their town or city.
- Region (`region`, text): Their county, state or region.
- Postcode (`postal_code`, text): Their postcode or ZIP code.
- Country code (`country_code`, text): Their two-letter country code, such as GB, US or DE.
- Language (`language`, text): The language of the emails GoCardless sends them, such as en or fr.
- Metadata (`metadata`, object): Your own notes to keep on the record, as keys and values. GoCardless allows up to 3 keys.

**Outputs**

- `customer` (object): The updated customer

**Example output**

```json
{
  "customer": {
    "address_line1": "1 Test Street",
    "address_line2": null,
    "address_line3": null,
    "city": "London",
    "company_name": null,
    "country_code": "GB",
    "created_at": "2026-11-13T19:02:34.598Z",
    "email": "jo@example.com",
    "family_name": "Bloggs",
    "given_name": "Jo",
    "id": "CU0123456789",
    "language": "en",
    "metadata": {},
    "phone_number": null,
    "postal_code": "EC1V 7EN",
    "region": null
  }
}
```

### Update payment

Change a payment's metadata or whether it is retried if it fails.

**Inputs**

- Payment (`payment_id`, text, required): The payment. Pick one, or give its ID (starts with PM) from an earlier step.
- Retry if it fails (`retry_if_possible`, true/false): Whether GoCardless retries the payment if it fails.
- Metadata (`metadata`, object): Your own notes to keep on the record, as keys and values. GoCardless allows up to 3 keys.

**Outputs**

- `payment` (object): The updated payment

**Example output**

```json
{
  "payment": {
    "amount": 1050,
    "amount_refunded": 0,
    "charge_date": "2026-11-20",
    "created_at": "2026-11-13T19:02:50.632Z",
    "currency": "GBP",
    "description": "Invoice 1042",
    "id": "PM0123456789",
    "links": {
      "creditor": "CR0123456789",
      "mandate": "MD0123456789"
    },
    "metadata": {},
    "reference": null,
    "retry_if_possible": false,
    "scheme": "bacs",
    "status": "pending_submission"
  }
}
```

### Update subscription

Change a subscription's name, amount, reference or metadata. Only the fields you fill in change.

**Inputs**

- Subscription (`subscription_id`, text, required): The subscription. Pick one, or give its ID (starts with SB) from an earlier step.
- Name (`name`, text): A new name. Leave empty to keep it.
- Amount (`amount`, number): A new amount for future payments, such as 7.50. Leave empty to keep it. At least 0.01.
- Payment reference (`payment_reference`, text): A new payment reference. Leave empty to keep it.
- Retry if a payment fails (`retry_if_possible`, true/false): Whether GoCardless retries failed payments.
- Metadata (`metadata`, object): Your own notes to keep on the record, as keys and values. GoCardless allows up to 3 keys.

**Outputs**

- `subscription` (object): The updated subscription

**Example output**

```json
{
  "subscription": {
    "amount": 500,
    "count": null,
    "created_at": "2026-11-13T19:02:51.064Z",
    "currency": "GBP",
    "day_of_month": null,
    "end_date": null,
    "id": "SB0123456789",
    "interval": 1,
    "interval_unit": "monthly",
    "links": {
      "mandate": "MD0123456789"
    },
    "metadata": {},
    "month": null,
    "name": "Monthly plan",
    "payment_reference": null,
    "retry_if_possible": false,
    "start_date": "2026-11-20",
    "status": "active",
    "upcoming_payments": [
      {
        "amount": 500,
        "charge_date": "2026-11-20"
      }
    ]
  }
}
```
