Core

Entity
Payout destinations
Payment types
Merchants
Payins
Customers
Payment methods
Webhooks
Tokens
- List tokensget
API keys

Classic

Transfers
Items
Agreements

Core

Entity
Payout destinations
Payment types
Merchants
Payins
Customers
Payment methods
Webhooks
Tokens
- List tokensget
API keys

Classic

Transfers
Items
Agreements

List agreements

get http://api.loopcrypto.xyz/api/v1/agreements

Lists all agreements associated with the authenticated entity. The request must include a valid API key with appropriate permissions. This endpoint is useful for managing multiple agreements.

URL Expired

The URL for this request expired after 30 days.

Query Params

string

Optional filter to retrieve agreements with a specific ID.

refId

string

Optional filter to retrieve agreements with a specific reference ID.

externalSubscriptionId

string

Optional filter to retrieve agreements with a specific external subscription ID. Useful for filtering agreements when only the external subscription ID is known

Responses

Response body

object

agreements

array of objects

required

A list of the returned agreements based on the request

agreements*

object

walletAddress

string

required

The address of the wallet for this agreement

networkId

double

required

1: “mainnet”, 5: “goerli”, 56: “bnb”, 97: “chapel (BNB testnet)”, 137: “polygon”, 42161: “arbitrum”, 80001: “mumbai (Polygon testnet)”

string | null

required

The email associated with the wallet

entityId

string

required

The ID of the entity the agreement relates to

token

string

required

The address of the ERC20 token authorized to be transferred

itemId

string

required

The ID of the item the agreement relates to

agreementId

string

required

The ID denoting the wallet / planID pair

startDate

double

required

Unix time in seconds that the record was created

status

double

required

1 - new, 2 - active, 3 - cancelled. The new status is used when a transfer request for a wallet that hasn’t signed up yet is received. We will create an agreement and when the wallet authorizes the contract, the status changes from new to active

cancelledAt

double | null

required

Unix time in seconds that the record was cancelled

cancellationEffectiveDate

double | null

required

Unix time in seconds of the end of the agreement period

cancellationReason

string | null

required

The reason the agreement was cancelled

refId

string | null

required

A custom reference ID that will be stored and returned via "SignedUp" and "Cancelled" webhooks

discountPercent

double | null

required

A percentage discount applied to the transfer amounts.

externalId

string | null

required

A Stripe or Chargebee Subscription ID

externalReferenceId

string | null

required

A reference ID for the our users use

cancellationSource

double | null

required

Cancellation source that denotes where the cancellation request originated from
1 - Loop Support, 2 - Chargebee, 3 - Stripe, 4 - Company Dashboard, 5 - Customer Portal, 6 - API Call, 7 - Auto Cancellation, 8 - Legacy Cancellation

Response body

object

code

number

required

The HTTP error code for this error

401

message

string

required

A message of why the error occurred

Unauthorized

Response body

object

code

number

required

The HTTP error code for this error

403

message

string

required

A message of why the error occurred

Forbidden

Response body

object

code

number

required

The HTTP error code for this error

422

message

string

required

A message of why the error occurred

Unprocessable Content

details

object

required

The details of why the validation failed

Has additional fields

Response body

object

code

number

required

The HTTP error code for this error

500

message

string

required

A message of why the error occurred

Internal Server Error

Response body

object

code

number

required

The HTTP error code for this error

504

message

string

required

A message of why the error occurred

Gateway Timeout

Updated 5 days ago

Update item

Create agreement

Did this page help you?

Language

Credentials

URL


xxxxxxxxxx
1
curl --request GET \
2
     --url http://api.loopcrypto.xyz/api/v1/agreements \
3
     --header 'accept: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

Updated 5 days ago

Update item

Create agreement

Did this page help you?

Core
Entity
Update entitypatch
Get entityget
Create entitypost
Payout destinations
List payout destinationsget
Delete payout destinationdelete
Get payout destinationget
Create payout destinationpost
Payment types
Delete payment typedelete
List payment typesget
Create payment typepost
Merchants
List merchantsget
Update merchantpatch
Get merchantget
Create merchantpost
Payins
List payinsget
Get payinget
Create payinpost
Customers
List customersget
Get merchant customerget
Update customerpatch
Get customerget
Create customerpost
Payment methods
List payment methodsget
Delete payment methoddelete
Get payment methodget
Create payment methodpost
Webhooks
Get webhook secretget
Generate new webhook secretput
Delete webhookdelete
Update webhookpatch
List webhooksget
Create webhookpost
Tokens
List tokensget
API keys
Update API keypatch
Delete API keydelete
List API keysget
Create API keypost

Classic
Transfers
Cancel transferspatch
Create transferpost
List transfersget
Items
Update itempatch
Create itempost
List itemsget
Agreements
Update agreement payment methodpatch
Disconnect agreement from Stripepost
Cancel agreementspatch
Create agreementpost
List agreementsget

Core
Entity
Update entitypatch
Get entityget
Create entitypost
Payout destinations
List payout destinationsget
Delete payout destinationdelete
Get payout destinationget
Create payout destinationpost
Payment types
Delete payment typedelete
List payment typesget
Create payment typepost
Merchants
List merchantsget
Update merchantpatch
Get merchantget
Create merchantpost
Payins
List payinsget
Get payinget
Create payinpost
Customers
List customersget
Get merchant customerget
Update customerpatch
Get customerget
Create customerpost
Payment methods
List payment methodsget
Delete payment methoddelete
Get payment methodget
Create payment methodpost
Webhooks
Get webhook secretget
Generate new webhook secretput
Delete webhookdelete
Update webhookpatch
List webhooksget
Create webhookpost
Tokens
List tokensget
API keys
Update API keypatch
Delete API keydelete
List API keysget
Create API keypost

Classic
Transfers
Cancel transferspatch
Create transferpost
List transfersget
Items
Update itempatch
Create itempost
List itemsget
Agreements
Update agreement payment methodpatch
Disconnect agreement from Stripepost
Cancel agreementspatch
Create agreementpost
List agreementsget

200Ok

401Unauthorized

403Forbidden

422Unprocessable Content

500Internal Server Error

504Gateway Timeout