Agreements

What are agreements?

When a wallet provides authorization to a contract either via the modal or checkout page an agreement is recorded noting the association between the wallet, item, and approved token. If more than one token is approved, more than one agreement is made. Every agreement has an agreementID which is used below in the API call to cancel this association.

Agreements are shown on the Customers page on the company dashboard. Here, you can send invoices and can cancel agreements by clicking "Manage" -> "Cancel" in the table:

Canceling agreements via API

Loop also provides an API endpoint to cancel agreements. After an agreement has been canceled, subscriber wallet authorizations for the contract will remain, as this can only be changed by the end customer. Canceling an agreement will automatically cancel any transfer requests that exist for that agreement.

PATCH//api/v1/agreements

Authorization

api_key

Header parameters

Body

application/json

agreementIds*array of string

This unique code represents the wallet / item association of the agreements to cancel

cancellationReasonstring

(Optional) Reason for the cancellation

Example: "No longer need the service"

Response

200400401403422500504

Ok

Body

application/json

agreements*array of GeneralAgreementResponse (object)

A list of the returned agreements based on the request

Request

JavaScriptCurlPython

const response = await fetch('//api/v1/agreements', {
    method: 'PATCH',
    headers: {
      "entity-id": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "agreementIds": [
        "83aac889-da5b-4432-ac51-b05cf3ae2aac"
      ]
    }),
});
const data = await response.json();

Response

200400401403422500504

{
  "agreements": [
    {
      "walletAddress": "0x56be8cpbed39582aad0eaa6e8f2adb109152fb6c",
      "networkId": 5,
      "email": "[e-mail]",
      "entityId": "911492f7-688d-11ed-9618-06613fde562",
      "token": "0x07865c6E87B9F70255377e024ace6630C1Eaa37F",
      "itemId": "8199041b-a8c2-40ae-b90d-633d3eb59111",
      "agreementId": "83aac889-da5b-4432-ac51-b05cf3ae2aac",
      "startDate": 1672423318,
      "status": 3,
      "cancelledAt": 1672761102,
      "cancellationEffectiveDate": 1672761534,
      "cancellationReason": "User requested",
      "refId": "user-42",
      "discountPercent": 42,
      "externalId": "sub_1ObTC0EsKlmFX3FHDjZnmim1",
      "externalReferenceId": "mySpecialreference",
      "cancellationSource": 3
    }
  ]
}

To get the agreementID, you can use the GET agreements endpoint to query all the wallets that have authorized your contract and their associated items.

GET//api/v1/agreements

Authorization

api_key

Query parameters

Header parameters

Response

200401403404422500504

Ok

Body

application/json

agreements*array of GeneralAgreementResponse (object)

A list of the returned agreements based on the request

Request

JavaScriptCurlPython

const response = await fetch('//api/v1/agreements', {
    method: 'GET',
    headers: {
      "entity-id": "text"
    },
});
const data = await response.json();

Response

200401403404422500504

{
  "agreements": [
    {
      "walletAddress": "0x56be8cpbed39582aad0eaa6e8f2adb109152fb6c",
      "networkId": 5,
      "email": "[e-mail]",
      "entityId": "911492f7-688d-11ed-9618-06613fde562",
      "token": "0x07865c6E87B9F70255377e024ace6630C1Eaa37F",
      "itemId": "8199041b-a8c2-40ae-b90d-633d3eb59111",
      "agreementId": "83aac889-da5b-4432-ac51-b05cf3ae2aac",
      "startDate": 1672423318,
      "status": 3,
      "cancelledAt": 1672761102,
      "cancellationEffectiveDate": 1672761534,
      "cancellationReason": "User requested",
      "refId": "user-42",
      "discountPercent": 42,
      "externalId": "sub_1ObTC0EsKlmFX3FHDjZnmim1",
      "externalReferenceId": "mySpecialreference",
      "cancellationSource": 3
    }
  ]
}