---
title: "Get agreement details"
method: GET
path: "/billingAgreement/{agreementId}"
tags: ["Billing Agreement"]
---

# Get agreement details

`GET /billingAgreement/{agreementId}`

## Path parameters

- `agreementId` string, required

## Query parameters

- `paymentProviderContract` string, required

## Response `200`

Successful

- Model8
  - `id` string, required — The ID of the agreement.
  - `state` string, required — The state of the agreement.
  - `description` string — The description of the agreement.
  - `merchant` Merchant
    - `payeeInfo` PayeeInfo
      - `email` string, required — The email address that is associated with the payee's PayPal account.
  - `payer` Payer
    - `payerInfo` PayerInfo
      - `email` string, required — The payer's email address.
      - `suffix` string — The payer's name suffix.
      - `firstName` string — The payer's first name.
      - `lastName` string — The payer's last name.
      - `payerId` string, required — The PayPal-assigned payer ID.
      - `phone` string — The payer's phone number.
      - `billingAddress` BillingAddress — Shipping Address details
        - `country` string, required — The two-character ISO 3166-1 code that identifies the country or region.
        - `postalCode` string, required — The postal code, which is the zip code or equivalent. Typically required for countries with a postal code or an equivalent.
        - `countrySubdivision` string — The highest level sub-division in a country, which is usually a province, state, or ISO-3166-2 subdivision.
        - `city` string — A city, town, or village. Smaller than admin_area_level_1
        - `addressLine2` string — The second line of the address. For example, suite or apartment number.
        - `addressLine1` string — The first line of the address. For example, number or street. For example, 173 Drury Lane. Required for data entry and compliance and risk checks. Must contain the full address.
  - `shippingAddress` ShippingAddress
    - `fullName` string — Full Name
    - `addressLine1` string, required — The first line of the address. For example, number or street. For example, 173 Drury Lane. Required for data entry and compliance and risk checks. Must contain the full address.
    - `addressLine2` string — The second line of the address. For example, suite or apartment number.
    - `city` string, required — A city, town, or village. Smaller than admin_area_level_1
    - `countrySubdivision` string, required — The highest level sub-division in a country, which is usually a province, state, or ISO-3166-2 subdivision.
    - `country` string, required — The two-character ISO 3166-1 code that identifies the country or region.
    - `postalCode` string, required — The postal code, which is the zip code or equivalent. Typically required for countries with a postal code or an equivalent.
  - `plan` Plan
    - `merchantPreferences` MerchantPreferences
      - `collectShippingAddress` string — Indicates whether to skip the collection of the shipping address from the customer during the agreement sign-up phase.
      - `enableAddressChange` string — Indicates whether to show the shipping address but prevent the customer from editing it.
      - `experienceId` string — The ID of the experience profile to apply during the agreement approval UI flow.
      - `externalSelectedFundingInstrumentType` string — The type of financial instrument (FI) that the merchant wants to promote.
      - `allowedCountries` string[] — An array of legally accepted customer country codes
  - `createTime` string, required — The date and time when the agreement was created.
  - `updateTime` string — The date and time when the agreement was updated.

## Other responses

- `400` — Bad Request
- `401` — Unauthorized
- `403` — Forbidden
- `404` — Not Found
- `500` — Internal Server Error

---

[API](https://skmtc.net/verifone/apis/checkout-api.md) · [All operations](https://skmtc.net/verifone/apis/checkout-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/verifone/checkout-api/revisions/ed8dc1f12a5a/schema)