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
POST /contract
Create a new contract for an account connection under your enterprise.
Body Parameters ID of Account Connection to request contract from.
Type of contract to create. See below for a list of available contract types.
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.
Minimum deposit amount that will trigger this contract. Must be a non-negative integer.
Maximum deposit amount that will trigger this contract. Must be a non-negative integer.
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.
split_fixed_amount_in_cents
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.
split_amount_max_in_cents
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.
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
}
GET /contract/:id
Retrieve a contract by its ID.
Path Parameters 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 The page number to return. Default is 1.
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 The ID of the account connection to list contracts for.
Query Parameters The page number to return. Default is 1.
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 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
Identifier for this contract.
Type of smart contract. Must be deposit_split.
Status of account connection. One of created, active, declined, terminated, or expired. Only users can activate a contract (through the Connect flow).
Source of funds for deposit split contracts. One of google, snap, or only_fans.
Minimum deposit amount that will trigger this contract.
Maximum deposit amount that will trigger this contract.
Percentage of eligible deposit to transfer to your enterprise’s operating account.
split_fixed_amount_in_cents
Fixed amount of eligible deposit to transfer to your enterprise’s operating account.
split_amount_max_in_cents
Maximum amount of transfer to your enterprise’s operating account per eligible deposit.
An activity log that tracks the status changes, internal transfers, and any errors associated with a given contract.
User defined data that can be attached to the object. See the User Data page for details.