Get an agreement for a tenant payment method

Get an agreement for a tenant payment method.

Required permissions: PAYMENT_METHOD

get

/tenants/{tenantUid}/paymentmethods/{tenantPaymentMethodUid}/agreements/{tenantPaymentMethodAgreementUid}

Authorizations

AuthorizationstringRequired

Access token recevied after user login with a deviceToken

Path parameters

tenantUidstringRequired

Reference to a tenant.

Pattern: ^[A-Za-z0-9-_]+

tenantPaymentMethodUidstringRequired

Reference to a tenant PaymentMethodUid.

Pattern: ^[A-Za-z0-9-_]+

tenantPaymentMethodAgreementUidstringRequired

Reference to a tenantPaymentMethodAgreementUid.

Pattern: ^[A-Za-z0-9-_]+

Responses

200Success

application/json

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.

tenantPaymentMethodAgreementUidstringRequiredPattern: ^[A-Za-z0-9-_]+

namestringRequired

Name of the agreement.

productUidstringRequiredPattern: ^[A-Za-z0-9-_]+

percentageintegerRequired

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.

validFromstring · date-time · nullableRequired

The agreement can be used from this point in time. Null means it has no start limit.

validTostring · date-time · nullableRequired

The agreement can be used until this point in time. Null means it has no end limit.

positionintegerRequired

Sort order when the agreements are listed.

activebooleanRequired

Whether the agreement can be used. An agreement that has been used should be deactivated rather than deleted.

createdAtstring · date-timeRequired

createdBystringRequired

lastModifiedAtstring · date-timeRequired

lastModifiedBystringRequired

get/tenants/{tenantUid}/paymentmethods/{tenantPaymentMethodUid}/agreements/{tenantPaymentMethodAgreementUid}

GET /v2/tenants/{tenantUid}/paymentmethods/{tenantPaymentMethodUid}/agreements/{tenantPaymentMethodAgreementUid} HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200Success

{
  "tenantPaymentMethodAgreementUid": "text",
  "name": "text",
  "productUid": "text",
  "percentage": 1,
  "validFrom": "2026-01-01T00:00:00.000Z",
  "validTo": "2026-01-01T00:00:00.000Z",
  "position": 1,
  "active": true,
  "createdAt": "2026-01-01T00:00:00.000Z",
  "createdBy": "text",
  "lastModifiedAt": "2026-01-01T00:00:00.000Z",
  "lastModifiedBy": "text"
}