---
title: "Changes to Create an agreement for recurring payments"
method: POST
path: "/v1/agreements"
---

# Changes to Create an agreement for recurring payments

`POST /v1/agreements`

> Every recorded change to this operation, newest first.

## Timeline

Changed in 9 of 40 revisions.

- **2025-01-21** `fdf8c84e093b`: 1 warning, 8 info
- **2023-09-26** `c030b46b3923`: 1 info
- **2023-06-15** `860f9048d3f6`: 1 info
- **2023-05-16** `ebde96e50a9d`: 1 info
- **2023-05-15** `171622b498a3`: 1 warning
- **2023-04-18** `c8f226fc66d4`: 3 info
- **2023-02-08** `9a97123032f3`: 1 warning
- **2023-02-08** `ad859fc4cc8f`: 5 warning, 2 info
- **2023-02-08** `3917b606b0dd`: 1 info

## Changes

- **2025-01-21** `fdf8c84e093b`: 1 warning, 8 info
  - removed the optional property `payment_instrument/CardDetails/wallet_type` from the response with the `201` status
  - the response optional property `payment_instrument/CardDetails/card_brand` became not read-only for the status `201`
  - the response optional property `payment_instrument/CardDetails/card_type` became not read-only for the status `201`
  - the response optional property `payment_instrument/CardDetails/expiry_date` became not read-only for the status `201`
  - the response optional property `payment_instrument/CardDetails/first_digits_card_number` became not read-only for the status `201`
  - the response optional property `payment_instrument/CardDetails/last_digits_card_number` became not read-only for the status `201`
  - removed the `credit` enum value from the `payment_instrument/CardDetails/card_type` response property for the response status `201`
  - removed the `debit` enum value from the `payment_instrument/CardDetails/card_type` response property for the response status `201`
  - removed the `null` enum value from the `payment_instrument/CardDetails/card_type` response property for the response status `201`
- **2023-09-26** `c030b46b3923`: 1 info
  - added the optional property `payment_instrument/CardDetails/wallet_type` to the response with the `201` status
- **2023-06-15** `860f9048d3f6`: 1 info
  - added the optional property `cancelled_date` to the response with the `201` status
- **2023-05-16** `ebde96e50a9d`: 1 info
  - removed the `expired` enum value from the `status` response property for the response status `201`
- **2023-05-15** `171622b498a3`: 1 warning
  - added the new `inactive` enum value to the `status` response property for the response status `201`
- **2023-04-18** `c8f226fc66d4`: 3 info
  - added the optional property `header` to the response with the `400` status
  - added the optional property `header` to the response with the `422` status
  - added the optional property `header` to the response with the `500` status
- **2023-02-08** `9a97123032f3`: 1 warning
  - added the new `card` enum value to the `payment_instrument/type` response property for the response status `201`
- **2023-02-08** `ad859fc4cc8f`: 5 warning, 2 info
  - removed the optional property `payment_instrument/card_details` from the response with the `201` status
  - added the new `active` enum value to the `status` response property for the response status `201`
  - added the new `cancelled` enum value to the `status` response property for the response status `201`
  - added the new `created` enum value to the `status` response property for the response status `201`
  - added the new `expired` enum value to the `status` response property for the response status `201`
  - removed the non-success response with the status `404`
  - added the optional property `payment_instrument/CardDetails` to the response with the `201` status
- **2023-02-08** `3917b606b0dd`: 1 info
  - endpoint added

---

[Operation](https://skmtc.dev/government-digital-service/apis/gov-uk-pay-api/docs/v1/agreements/post.md) - [API](https://skmtc.dev/government-digital-service/apis/gov-uk-pay-api.md) - [Page](https://skmtc.dev/government-digital-service/apis/gov-uk-pay-api/changes/v1/agreements/post)