Overview

The Contract object represents an automation that your enterprise requests from a creator. For a typical integration, you’ll create an Account Connection for a creator in your system, then create a Contract referencing that account connection, before directing them opt in via a Connect Link.

Methods

Create
Get
List
List for Account Connection
Delete

POST /contract
Create a new contract for an account connection under your enterprise.

Body Parameters

string

required

ID of Account Connection to request contract from.

string

required

Type of contract to create. See below for a list of available contract types.

string

required

Source of funds deposited into the creator’s account that will trigger this contract. Required if type is deposit_split. See below for list of available deposit sources.

number

Minimum deposit amount that will trigger this contract. Must be a non-negative integer.

number

Maximum deposit amount that will trigger this contract. Must be a non-negative integer.

number

required

Percentage of eligible deposit to transfer to your enterprise’s operating account. Either this or split_fixed_amount_in_cents is required if type is deposit_split. Must be a number between 0 and 100.

number

required

Fixed amount of eligible deposit to transfer to your enterprise’s operating account. Either this or split_percent_amount is required if type is deposit_split. Must be a non-negative integer.

number

Maximum amount of transfer to your enterprise’s operating account per eligible deposit. Must be a non-negative integer. If not provided, there is no maximum.

object

User defined data that can be attached to the object. See the User Data page for details.

Example

// POST /contract
{
    "account_connection": "acon_XXXXX",
    "type": "deposit_split",
    "deposit_source": "snap",
    "split_percent_amount": 10
}

{
    "id": "con_XXXXX",
    "created_at": "2026-01-15T19:27:58.246Z",
    "updated_at": "2026-01-15T19:27:58.246Z",
    "type": "deposit_split",
    "account_connection": "acon_XXXXX",
    "status": "created",
    "activity": [
        {
            "entry": "Automation created",
            "date": "2026-01-15T19:27:58.245Z",
            "hidden": false
        }
    ],
    "deposit_source": "snap",
    "deposit_minimum_in_cents": 0,
    "split_fixed_amount_in_cents": 0,
    "split_percent_amount": 10,
    "fee_fixed_amount_in_cents": 0,
    "fee_percent_amount": 0,
    "fee_amount_max_in_cents": null
}

GET /contract/:id
Retrieve a contract by its ID.

Path Parameters

string

required

The ID of the contract to retrieve.

Example

{
    "id": "con_XXXXX",
    "created_at": "2026-01-15T19:27:58.246Z",
    "updated_at": "2026-01-15T19:27:58.246Z",
    "type": "deposit_split",
    "account_connection": "acon_XXXXX",
    "status": "created",
    "activity": [
        {
            "entry": "Automation created",
            "date": "2026-01-15T19:27:58.245Z",
            "hidden": false
        }
    ],
    "deposit_source": "snap",
    "deposit_minimum_in_cents": 0,
    "split_fixed_amount_in_cents": 0,
    "split_percent_amount": 10,
    "fee_fixed_amount_in_cents": 0,
    "fee_percent_amount": 0,
    "fee_amount_max_in_cents": null
}

GET /contract
List all contracts associated with your enterprise.

Query Parameters

integer

The page number to return. Default is 1.

integer

The number of items to return per page. Default is 10.

Example

{
    "data": [
        {
            "id": "con_XXXXX",
            "created_at": "2026-01-15T19:27:58.246Z",
            "updated_at": "2026-01-15T19:27:58.246Z",
            "type": "deposit_split",
            "account_connection": "acon_XXXXX",
            "status": "created",
            "activity": [
                {
                    "entry": "Automation created",
                    "date": "2026-01-15T19:27:58.245Z",
                    "hidden": false
                }
            ],
            "deposit_source": "snap",
            "deposit_minimum_in_cents": 0,
            "split_fixed_amount_in_cents": 0,
            "split_percent_amount": 10,
            "fee_fixed_amount_in_cents": 0,
            "fee_percent_amount": 0,
            "fee_amount_max_in_cents": null
        },
        {
            "id": "con_YYYYY",
            "created_at": "2026-01-15T19:27:58.246Z",
            "updated_at": "2026-01-15T19:27:58.246Z",
            "type": "deposit_split",
            "account_connection": "acon_YYYYY",
            "status": "created",
            "activity": [
                {
                    "entry": "Automation created",
                    "date": "2026-01-15T19:27:58.245Z",
                    "hidden": false
                }
            ],
            "deposit_source": "google",
            "deposit_minimum_in_cents": 0,
            "split_fixed_amount_in_cents": 0,
            "split_percent_amount": 10,
            "fee_fixed_amount_in_cents": 0,
            "fee_percent_amount": 0,
            "fee_amount_max_in_cents": null
        }
    ],
    "pagination": {
        "page": 1,
        "page_size": 10,
        "total": 2
    }
}

GET /account-connection/:id/contract
List all contracts from your enterprise to a specific account connection.

Path Parameters

string

required

The ID of the account connection to list contracts for.

Query Parameters

integer

The page number to return. Default is 1.

integer

The number of items to return per page. Default is 10.

Example

{
    "data": [
        {
            "id": "con_XXXXX",
            "created_at": "2026-01-15T19:27:58.246Z",
            "updated_at": "2026-01-15T19:27:58.246Z",
            "type": "deposit_split",
            "account_connection": "acon_XXXXX",
            "status": "created",
            "activity": [
                {
                    "entry": "Automation created",
                    "date": "2026-01-15T19:27:58.245Z",
                    "hidden": false
                }
            ],
            "deposit_source": "snap",
            "deposit_minimum_in_cents": 0,
            "split_fixed_amount_in_cents": 0,
            "split_percent_amount": 10,
            "fee_fixed_amount_in_cents": 0,
            "fee_percent_amount": 0,
            "fee_amount_max_in_cents": null
        },
        {
            "id": "con_YYYYY",
            "created_at": "2026-01-15T19:27:58.246Z",
            "updated_at": "2026-01-15T19:27:58.246Z",
            "type": "deposit_split",
            "account_connection": "acon_XXXXX",
            "status": "created",
            "activity": [
                {
                    "entry": "Automation created",
                    "date": "2026-01-15T19:27:58.245Z",
                    "hidden": false
                }
            ],
            "deposit_source": "google",
            "deposit_minimum_in_cents": 0,
            "split_fixed_amount_in_cents": 0,
            "split_percent_amount": 10,
            "fee_fixed_amount_in_cents": 0,
            "fee_percent_amount": 0,
            "fee_amount_max_in_cents": null
        }
    ],
    "pagination": {
        "page": 1,
        "page_size": 10,
        "total": 2
    }
}

DELETE /contract/:id
Terminate contract. This will stop any future automations from occurring under this contract.

Path Parameters

string

required

The ID of the contract to terminate.

Example

{
    "id": "con_XXXXX",
    "created_at": "2026-01-15T19:29:26.000Z",
    "updated_at": "2026-01-15T19:35:30.000Z",
    "type": "deposit_split",
    "account_connection": "acon_XXXXX",
    "status": "terminated",
    "expires_at": null,
    "agreement_at": null,
    "agreement_ip": null,
    "deleted_at": "2026-01-15T19:35:30.000Z",
    "activity": [
        {
            "date": "2026-01-15T19:29:26.948Z",
            "entry": "Automation created",
            "hidden": false
        },
        {
            "date": "2026-01-15T19:35:30.847Z",
            "entry": "Automation terminated by enterprise",
            "hidden": false
        }
    ],
    "deposit_source": "snap",
    "deposit_minimum_in_cents": 0,
    "deposit_maximum_in_cents": null,
    "split_fixed_amount_in_cents": 0,
    "split_percent_amount": 10,
    "split_amount_max_in_cents": null,
    "fee_fixed_amount_in_cents": 0,
    "fee_percent_amount": 0,
    "fee_amount_max_in_cents": null
}

Properties

string

Identifier for this contract.

string

Type of smart contract. Must be deposit_split.

string

Status of account connection. One of created, active, declined, terminated, or expired. Only users can activate a contract (through the Connect flow).

string

Source of funds for deposit split contracts. One of google, snap, or only_fans.

number

Minimum deposit amount that will trigger this contract.

number

Maximum deposit amount that will trigger this contract.

number

Percentage of eligible deposit to transfer to your enterprise’s operating account.

number

Fixed amount of eligible deposit to transfer to your enterprise’s operating account.

number

Maximum amount of transfer to your enterprise’s operating account per eligible deposit.

object[]

An activity log that tracks the status changes, internal transfers, and any errors associated with a given contract.

object

User defined data that can be attached to the object. See the User Data page for details.

Documentation

Sending Money

Receiving Money

Automations

Resources

Reference

Smart Contracts

Overview

Methods

Body Parameters

Example

Path Parameters

Example

Query Parameters

Example

Path Parameters

Query Parameters

Example

Path Parameters

Example

Properties

​Overview

​Methods

​Body Parameters

​Example

​Path Parameters

​Example

​Query Parameters

​Example

​Path Parameters

​Query Parameters

​Example

​Path Parameters

​Example

​Properties

Overview

Methods

Body Parameters

Example

Path Parameters

Example

Query Parameters

Example

Path Parameters

Query Parameters

Example

Path Parameters

Example

Properties