Instalment Schedule

POST https://api.gocardless.com/instalment_schedules HTTP/1.1
Content-Type: application/json
{
  "instalment_schedules": {
    "name": "Bike Invoice 271",
    "currency": "GBP",
    "total_amount": "2500",
    "instalments": {
      "start_date": "2019-12-14",
      "interval_unit": "monthly",
      "interval": 1,
      "amounts": [
        "1500",
        "1000"
      ]
    },
    "metadata": {},
    "links": {
      "mandate": "MD123"
    }
  }
}

instalment_schedule = @client.instalment_schedules.create_with_schedule(
  params: {
    name: 'ACME Invoice 103',
    total_amount: 10_000, # 100 GBP in pence, collected from the customer
    app_fee: 10, # Your 10 pence fee, applied to each instalment,
                 # to be paid out to you
    currency: 'GBP',
    instalments: {
      start_date: '2019-08-20',
      interval_unit: 'weekly',
      interval: 2,
      amounts: [
        3_400,
        3_400,
        3_200
      ]
    },
    links: {
      mandate: 'MD0000XH9A3T4C'
    },
    metadata: {}
  },
  headers: {
    'Idempotency-Key': 'random_instalment_schedule_specific_string'
  }
)

instalment_schedule = client.instalment_schedules.create_with_schedule(
    params={
        "name": "ACME Invoice 103",
        "total_amount": 10000, # 100 GBP in pence, collected from the customer
        "app_fee": 10, # Your 10 pence fee, applied to each instalment,
                       # to be paid out to you
        "currency": "GBP",
        "instalments": {
            "start_date": "2019-08-20",
            "interval_unit": "weekly",
            "interval": 2,
            "amounts": [
                3400,
                3400,
                3200
            ]
        },
        "links": {
            "mandate": "MD0000XH9A3T4C"
        },
        "metadata": {}
    }, headers={
        "Idempotency-Key": "random_instalment_schedule_specific_string"
    }
)

const instalmentSchedule = await client.instalmentSchedules.createWithSchedule(
  {
    name: "ACME Invoice 103",
    total_amount: "10000", // 100 GBP in pence, collected from the customer
    app_fee: "10", // Your 10 pence fee, applied to each instalment,
                 // to be paid out to you
    currency: "GBP",
    instalments: {
      start_date: "2019-08-20",
      interval_unit: "weekly",
      interval: 2,
      amounts: [
        "3400",
        "3400",
        "3200"
      ]
    },
    links: {
      mandate: "MD0000XH9A3T4C"
    },
    metadata: {}
  },
  "instalment_schedule_idempotency_key"
);

$instalment_schedule = $client->instalmentSchedules()->createWithSchedule([
    "params" => [
        "name" => "ACME Invoice 103",
        "total_amount" => 10000, // 100 GBP in pence, collected from the customer
        "app_fee" => 10, // Your 10 pence fee, applied to each instalment,
                         // to be paid out to you
        "currency" => "GBP",
        "instalments" => [
            "start_date" => "2019-08-20",
            "interval_unit" => "weekly",
            "interval" => 2,
            "amounts" => [
                3400,
                3400,
                3200
            ]
        ],
        "links" => [
            "mandate" => "MD0000XH9A3T4C"
        ],
        "metadata" => []
    ],
    "headers" => [
        "Idempotency-Key" => "random_instalment_schedule_specific_string"
    ]
]);

import com.gocardless.services.InstalmentScheduleService.InstalmentScheduleCreateWithScheduleRequest.Instalments.IntervalUnit;
import java.util.Arrays;

InstalmentSchedule instalmentSchedule = client.instalmentSchedules().createWithSchedule()
    .withTotalAmount(10000) // 100 GBP in Pence, collected from the customer.
    .withAppFee(10)  // Your 10 pence fee, applied to each instalment, to be
                     // paid out to you
    .withCurrency(com.gocardless.services.InstalmentScheduleService.InstalmentScheduleCreateWithScheduleRequest.Currency.GBP)
    .withInstalmentsIntervalUnit(IntervalUnit.WEEKLY)
    .withInstalmentsInterval(2)
    .withInstalmentsAmounts(Arrays.asList(3400, 3400, 3200))
    .withLinksMandate("MD0000YTKZKY4J")
    .withMetadata("invoiceId", "001")
    .withIdempotencyKey("random_instalment_schedule_specific_string")
    .execute();

instalmentScheduleCreateWithScheduleParams := gocardless.InstalmentScheduleCreateWithScheduleParams{
  TotalAmount: 10000,
  AppFee:      10,
  Currency:    "GBP",
  Instalments: gocardless.InstalmentScheduleCreateWithScheduleParamsInstalments{
    Interval:     2,
    IntervalUnit: "monthly",
    Amounts:      []int{3400, 3400, 3200},
  },
  Metadata: map[string]string{"invoiceId": "001"},
}

requestOption := gocardless.WithIdempotencyKey("random_instalment_schedule_specific_string")
instalmentSchedule, err := client.InstalmentSchedules.CreateWithSchedule(ctx, instalmentScheduleCreateWithScheduleParams, requestOption)

using GoCardless.Services;
using System.Collections.Generic;

int?[] amountsArray = new int?[]{ 3400, 3400, 3200 };
var createResponse = await client.InstalmentSchedules.CreateWithScheduleAsync(
    new InstalmentScheduleCreateWithScheduleRequest
    {
        TotalAmount = 10000, // 100 GBP in pence, collected from the customer
        AppFee = 10, // Your 10 pence fee, applied to each instalment,
                     // to be paid out to you
        Currency = InstalmentScheduleCreateWithScheduleRequest.InstalmentScheduleCurrency.GBP,
        Name = "ACME Invoice 103",
        Instalments = new InstalmentScheduleCreateWithScheduleRequest.InstalmentScheduleInstalments
        {
            StartDate = "2019-08-20",
            IntervalUnit = InstalmentScheduleCreateWithScheduleRequest.InstalmentScheduleInstalments.InstalmentScheduleIntervalUnit.Weekly,
            Interval = 2,
            Amounts = amountsArray
        },
        Metadata = new Dictionary<string, string>
        {
            {"Invoice ID", "001"}
        },
        Links = new InstalmentScheduleCreateWithScheduleRequest.InstalmentScheduleLinks
        {
            Mandate = "MD0000XH9A3T4C"
        },
        IdempotencyKey = "random_instalment_schedule_specific_string"
    }
);

GET https://api.gocardless.com/instalment_schedules?after=IS123 HTTP/1.1

@client.instalment_schedules.list

@client.instalment_schedules.list(
  params: {
    "created_at[gt]" => "2016-08-06T09:30:00Z"
  }
)

@client.instalment_schedules.list.records.each do |instalment_schedule|
  puts instalment_schedule.inspect
end

client.instalment_schedules.list().records

client.instalment_schedules.list(params={"after": "IS123"}).records

const instalmentSchedules = await client.instalmentSchedules.list();

// List all instalment schedules associated with a given customer.
const customerInstalmentSchedules = await client.instalmentSchedules.list({ customer: "CU123" });

$client->instalmentSchedules()->list();

$client->instalmentSchedules()->list([
  "params" => ["created_at[gt]" => "2015-11-03T09:30:00Z"]
]);

for (InstalmentSchedule instalmentSchedule : client.instalmentSchedules().all().execute()) {
  System.out.println(instalmentSchedule.getId());
}

instalmentScheduleListParams := gocardless.InstalmentScheduleListParams{}
instalmentScheduleListResult, err := client.InstalmentSchedules.List(ctx, instalmentScheduleListParams)
for _, instalmentSchedule := range instalmentScheduleListResult.InstalmentSchedules {
    fmt.Println(instalmentSchedule.Name)
}

var instalmentScheduleListResponse = client.InstalmentSchedules.All();
foreach (GoCardless.Resources.InstalmentSchedule instalmentSchedule in instalmentScheduleListResponse)
{
    Console.WriteLine(instalmentSchedule.Name);
}

GET https://api.gocardless.com/instalment_schedules/IS123 HTTP/1.1

@client.instalment_schedules.get("IS123")

client.instalment_schedules.get("IS123")

const instalmentSchedule = await client.instalmentSchedules.find("IS123");

$client->instalmentSchedules()->get("IS123");

InstalmentSchedule instalmentSchedule = client.instalmentSchedules().get("IS123").execute();

instalmentSchedule, err := client.InstalmentSchedules.Get(ctx, "IS123")

var instalmentScheduleResponse = await client.InstalmentSchedules.GetAsync("IS123");
GoCardless.Resources.InstalmentSchedule instalmentSchedule = instalmentScheduleResponse.InstalmentSchedule;

PUT https://api.gocardless.com/instalment_schedules/IS123 HTTP/1.1
Content-Type: application/json
{
  "instalment_schedules": {
    "metadata": {
      "key": "value"
    }
  }
}

@client.instalment_schedules.update(
  "IS123",
  params: {
    metadata: { key: "value" }
  }
)

client.instalment_schedules.update("IS123", params={
  "metadata": {"key": "value"}
})

const instalmentSchedule = await client.instalmentSchedules.update(
  "IS123",
  {
    metadata: {
      key: "value"
    }
  }
);

$client->instalmentSchedules()->update("IS123", [
  "params" => ["metadata" => ["key" => "value"]]
]);

client.instalmentSchedules().update("IS123")
  .withMetadata("key", "value")
  .execute();

instalmentScheduleUpdateParams := gocardless.InstalmentScheduleUpdateParams{
  Metadata: map[string]string{"key": "value"},
}

instalmentSchedule, err := client.InstalmentSchedules.Update(ctx, "IS123", instalmentScheduleUpdateParams)

using GoCardless.Services;
using System.Collections.Generic;

var instalmentScheduleRequest = new InstalmentScheduleUpdateRequest()
{
    Metadata = new Dictionary<string, string>()
    {
        {"key", "value"}
    }
};

var instalmentScheduleResponse = await client.InstalmentSchedules.UpdateAsync("IS123", instalmentScheduleRequest);

POST https://api.gocardless.com/instalment_schedules/IS123/actions/cancel HTTP/1.1

@client.instalment_schedules.cancel("IS123")

client.instalment_schedules.cancel("IS123")

const instalmentScheduleResponse = await client.instalmentSchedules.cancel("IS123");

$client->instalmentSchedules()->cancel("IS123");

client.instalmentSchedules().cancel("IS123").execute();

instalmentScheduleCancelParams := gocardless.InstalmentScheduleCancelParams{}
instalmentSchedule, err := client.InstalmentSchedules.Cancel(ctx, "IS123", instalmentScheduleCancelParams)

var response = await client.InstalmentSchedules.CancelAsync("IS123");