---
title: "Get information about a single agreement for recurring payments"
method: GET
path: "/v1/agreements/{agreementId}"
tags: ["Agreements"]
---

# Get information about a single agreement for recurring payments

`GET /v1/agreements/{agreementId}`

## Request

- Base URL: `https://publicapi.payments.service.gov.uk`
- URL: `https://publicapi.payments.service.gov.uk/v1/agreements/{agreementId}`
- Auth: HTTP bearer

You can use this endpoint to get information about a single recurring payments agreement.

## Path parameters

- `agreementId` string, required

## Response `200`

OK - your request was successful.

- Agreement: Contains information about a user's agreement for recurring payments. An agreement represents an understanding between you and your paying user that you'll use their card to make ongoing payments for a service.
  - `agreement_id` string: The unique ID GOV.UK Pay automatically associated with this agreement when you created it.
  - `cancelled_date` string: The date and time this agreement was cancelled. This value uses Coordinated Universal Time (UTC) and ISO 8601 format – `YYYY-MM-DDThh:mm:ss.sssZ`.
  - `created_date` string: The date and time you created this agreement. This value uses Coordinated Universal Time (UTC) and ISO 8601 format – `YYYY-MM-DDThh:mm:ss.sssZ`.
  - `description` string: The description you sent when creating this agreement.
  - `payment_instrument` PaymentInstrument
    - `CardDetails` CardDetailsFromResponse
      - `billing_address` Address: A structure representing the billing address of a card
        - `city` string: The paying user's city.
        - `country` string: The paying user’s country, displayed as a 2-character ISO-3166-1-alpha-2 code.
        - `line1` string: The first line of the paying user’s address.
        - `line2` string: The second line of the paying user’s address.
        - `postcode` string: The paying user's postcode.
      - `card_brand` string
      - `card_type` string
      - `cardholder_name` string
      - `expiry_date` string
      - `first_digits_card_number` string
      - `last_digits_card_number` string
    - `created_date` string: The date and time you created this payment instrument. This value uses Coordinated Universal Time (UTC) and ISO 8601 format – `YYYY-MM-DDThh:mm:ss.sssZ`.
    - `type` 'card': The type of payment instrument.
  - `reference` string: The reference you sent when creating this agreement.
  - `status` 'created' | 'active' | 'cancelled' | 'inactive': The status of this agreement. You can [read more about the meanings of each agreement status.](https://docs.payments.service.gov.uk/recurring_payments/#understanding-agreement-status)
  - `user_identifier` string: The identifier you sent when creating this agreement. `user_identifier` helps you identify users in your records.

## Other responses

- `401`: Your API key is missing or invalid. Read more about [authenticating GOV.UK Pay API requests](https://docs.payments.service.gov.uk/api_reference/#authentication)
- `404`: Not found
- `429`: Too many requests
- `500`: Downstream system error

## Changes

- **2025-01-21** `fdf8c84e093b`: 1 warning, 8 info
  - removed the optional property `payment_instrument/CardDetails/wallet_type` from the response with the `200` status
  - the response optional property `payment_instrument/CardDetails/card_brand` became not read-only for the status `200`
  - the response optional property `payment_instrument/CardDetails/card_type` became not read-only for the status `200`
  - the response optional property `payment_instrument/CardDetails/expiry_date` became not read-only for the status `200`
  - …5 more
- **2023-09-26** `c030b46b3923`: 1 info
  - added the optional property `payment_instrument/CardDetails/wallet_type` to the response with the `200` status
- **2023-06-15** `860f9048d3f6`: 1 info
  - added the optional property `cancelled_date` to the response with the `200` status
- **2023-05-16** `ebde96e50a9d`: 1 info
  - removed the `expired` enum value from the `status` response property for the response status `200`
- **2023-05-15** `171622b498a3`: 1 warning
  - added the new `inactive` enum value to the `status` response property for the response status `200`

[Operation history](https://skmtc.dev/government-digital-service/apis/gov-uk-pay-api/changes/v1/agreements/:agreementId/get.md)

---

[API](https://skmtc.dev/government-digital-service/apis/gov-uk-pay-api.md) - [All operations](https://skmtc.dev/government-digital-service/apis/gov-uk-pay-api/llms.txt) - [OpenAPI document](https://skmtc.dev/government-digital-service/apis/gov-uk-pay-api/revisions/6dc4b2c91eb8?raw)