Guides

Collect Payments

Setting up mandates

Direct Debit Mandates Verified Mandates Collecting mandates offline Importing Mandates

One-off payments

One-Off Direct Debit Instant Bank Pay

Recurring payments

Subscriptions Instalments Variable Recurring Payments Instant Bank Pay + Direct Debit

Events & Webhooks

Mandate Events Billing Requests Events

Managing payments

FX Payments Reconciling Payouts

Scheme guidance

ACH and PAD Consent Types Billing Request Purpose Codes VRP Commercial Payment Purpose Codes PayTo Agreements and Payments

Send money

Introduction to Outbound Payments Payment Account API request signing

Send an outbound payment

Adding a new recipient Initiate an outbound payment Approve an outbound payment Cancel an outbound payment

Tracking outbound payments Bank Account Holder Verification Strong Customer Authentication

Optimise and increase revenue

Prevent fraud with Protect+ Retain customers with fallbacks Reduced failed payments with Success+

Prefill customer details

New customer record Existing customer record Populate Billing Request Flow

Blocking mandates

Tutorials

Taking Direct Debit payments using Billing Requests and Custom Payment Pages Handling tax Handling Customer Notifications

GoCardless Embed

Introduction Creating a creditor Adding a creditor bank account Optional Setting a scheme identifer Optional

Setting up mandates / collecting payments

Billing Request with Actions: Setting up a Direct Debit mandate Collecting a Direct Debit payment Billing Request with Actions: Taking an Instant Bank Payment Billing Request with Actions Dual Flow: Taking an Instant Bank Payment and setting up a Direct Debit mandate

Handling webhooks

Reconciling payouts

Payout Items API Automated Payout Reporting Optional

Setting Up Branding Optional API request signing Optional Bank Details Access Optional

Bank Account Data

Overview Quickstart Guide Endpoints Bank Selection UI Sandbox Statuses and Error code Output: Account Details Output: Balances Output: Transaction Details Postman Collection FAQs

Direct Debit: Taking Subscription Payments

View as Markdown

Using subscriptions

Now, let’s create a subscription. Subscriptions collect a fixed, regular amount from a customer.

Let’s try collecting £15 per month on the 5th of each month from our customer:

<?php
require 'vendor/autoload.php';

$client = new \GoCardlessPro\Client([
    'access_token' => getenv('GC_ACCESS_TOKEN'),
    'environment' => \GoCardlessPro\Environment::SANDBOX
]);

$subscription = $client->subscriptions()->create([
  "params" => [
      "amount" => 1500, // 15 GBP in pence
      "currency" => "GBP",
      "interval_unit" => "monthly",
      "day_of_month" => "5",
      "links" => [
          "mandate" => "MD0000XH9A3T4C"
                       // Mandate ID from the last section
      ],
      "metadata" => [
          "subscription_number" => "ABC1234"
      ]
  ],
  "headers" => [
      "Idempotency-Key" => "random_subscription_specific_string"
  ]
]);

// Keep hold of this subscription ID - we'll use it in a minute.
// It should look a bit like "SB00003GKMHFFY"
print("ID: " . $subscription->id);

Each month, on the 5th of the month, the subscription will generate a new payment for £15 to be collected from the customer.

With the subscription ID, we can grab the subscription from the API. Let’s then try cancelling it so that no further payments are taken:

<?php
require 'vendor/autoload.php';

$client = new \GoCardlessPro\Client([
    'access_token' => getenv('GC_ACCESS_TOKEN'),
    'environment' => \GoCardlessPro\Environment::SANDBOX
]);

$subscription = $client->subscriptions()->get("SB00003GKMHFFY");
                                        // Subscription ID from above.

print("Status: " . $subscription->status . "<br />");
print("Cancelling...<br />");

$subscription = $client->subscriptions()->cancel("SB00003GKMHFFY");

print("Status: " . $subscription->status . "<br />");

What's Next?

Taking instalment payments against a mandate

More Guides

Taking a one-off payment against a mandate

Taking subscription payments against a mandate

Connect as a partner