> For the complete documentation index, see [llms.txt](https://docs.flowretail.com/docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.flowretail.com/docs/developers/api-documentation/payment-method-agreements/list-agreements-for-a-tenant-payment-method.md).

# List agreements for a tenant payment method

List the agreements configured on a tenant payment method.

Results are sorted by `position` ascending, then `name`, when no sorting parameter is specified. `sortBy` accepts `name`, `percentage`, `position`, `validFrom`, `validTo`, `active`, `createdAt` and `lastModifiedAt`.

Required permissions: PAYMENT\_METHOD

```json
{"openapi":"3.0.2","info":{"title":"Flow Retail API version 2","version":"2.0.0"},"tags":[{"name":"PaymentMethodAgreements","description":"PaymentMethodAgreements"}],"servers":[{"description":"Flow Retail Production","url":"https://api.flowretail.com/v2"},{"description":"Flow Retail Stage","url":"https://api.stage.flowretail.com/v2"}],"security":[{"accessToken":[]},{"authToken":[]},{"integrationToken":[]}],"components":{"securitySchemes":{"accessToken":{"description":"Access token recevied after user login with a deviceToken","scheme":"bearer","type":"http"},"authToken":{"description":"Token received from the auth service","scheme":"bearer","type":"http"},"integrationToken":{"scheme":"bearer","type":"http"}},"responses":{"TenantPaymentMethodAgreementListResponse":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/TenantPaymentMethodAgreementResponseSchema"}},"paging":{"$ref":"#/components/schemas/Paging"}},"required":["items","paging"]}}}}},"schemas":{"TenantPaymentMethodAgreementResponseSchema":{"title":"TenantPaymentMethodAgreementResponseSchema","description":"An agreement configured on this payment method: a named pairing of a product with a percentage. Choosing one at payment adds a line to the order for that product, carrying a cost derived from the percentage. This response describes the configuration, so it also returns agreements that cannot currently be chosen — inactive ones, and ones outside their validity period. The product must be of type NON_PHYSICAL and must allow an order specific cost.","type":"object","properties":{"tenantPaymentMethodAgreementUid":{"$ref":"#/components/schemas/UID"},"name":{"type":"string","description":"Name of the agreement."},"productUid":{"$ref":"#/components/schemas/UID"},"percentage":{"type":"integer","description":"Percentage used to calculate the cost adjustment, given in hundredths of a percent: 250 means 2,50 %. A positive percentage gives a negative cost, and a negative percentage gives a positive cost."},"validFrom":{"type":"string","format":"date-time","nullable":true,"description":"The agreement can be used from this point in time. Null means it has no start limit."},"validTo":{"type":"string","format":"date-time","nullable":true,"description":"The agreement can be used until this point in time. Null means it has no end limit."},"position":{"type":"integer","description":"Sort order when the agreements are listed."},"active":{"type":"boolean","description":"Whether the agreement can be used. An agreement that has been used should be deactivated rather than deleted."},"createdAt":{"type":"string","format":"date-time"},"createdBy":{"type":"string"},"lastModifiedAt":{"type":"string","format":"date-time"},"lastModifiedBy":{"type":"string"}},"required":["tenantPaymentMethodAgreementUid","name","productUid","percentage","validFrom","validTo","position","active","createdAt","createdBy","lastModifiedAt","lastModifiedBy"]},"UID":{"title":"UID","type":"string","pattern":"^[A-Za-z0-9-_]+"},"Paging":{"description":"totalCount The total number of items in the result set.\n\npageSize The number of items per page.\n\npageNumber The current page in the result set.","properties":{"pageNumber":{"type":"integer"},"pageSize":{"type":"integer"},"totalCount":{"type":"integer"}},"required":["totalCount","pageSize","pageNumber"],"title":"Paging","type":"object"},"SortDirectionENUM":{"description":"|ENUM      | Description |\n| ---------------- | ------------ |\n| ASC | Sort in ascending order|\n| DESC | Sort in descending order|\n","enum":["ASC","DESC"],"title":"SortDirectionENUM","type":"string"}},"parameters":{"tenantPaymentMethodAgreementActiveQuery":{"description":"Filter agreements on active status. When true, only active agreements are returned. When false, only inactive agreements are returned. When omitted, all agreements are returned.","in":"query","name":"active","required":false,"schema":{"type":"boolean"}},"pageNumberQuery":{"description":"Reference to a specific page in a result set.","in":"query","name":"pageNumber","required":false,"schema":{"type":"integer"}},"pageSizeQuery":{"description":"The number of items per page in a result set.","in":"query","name":"pageSize","required":false,"schema":{"type":"integer"}},"sortByQuery":{"description":"Defines which field the resource list is sorted by.","in":"query","name":"sortBy","required":false,"schema":{"type":"string"}},"sortDirectionQuery":{"description":"Reference to a sort direction","explode":false,"in":"query","name":"sortDirection","schema":{"$ref":"#/components/schemas/SortDirectionENUM"},"style":"form"}}},"paths":{"/tenants/{tenantUid}/paymentmethods/{tenantPaymentMethodUid}/agreements":{"get":{"summary":"List agreements for a tenant payment method","responses":{"200":{"$ref":"#/components/responses/TenantPaymentMethodAgreementListResponse"}},"operationId":"list-tenants-paymentmethods-agreements","description":"List the agreements configured on a tenant payment method.\n\nResults are sorted by `position` ascending, then `name`, when no sorting\nparameter is specified. `sortBy` accepts `name`, `percentage`, `position`,\n`validFrom`, `validTo`, `active`, `createdAt` and `lastModifiedAt`.\n\nRequired permissions: PAYMENT_METHOD","parameters":[{"$ref":"#/components/parameters/tenantPaymentMethodAgreementActiveQuery"},{"$ref":"#/components/parameters/pageNumberQuery"},{"$ref":"#/components/parameters/pageSizeQuery"},{"$ref":"#/components/parameters/sortByQuery"},{"$ref":"#/components/parameters/sortDirectionQuery"}],"tags":["PaymentMethodAgreements"]}}}}
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.flowretail.com/docs/developers/api-documentation/payment-method-agreements/list-agreements-for-a-tenant-payment-method.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.