List Commissions

curl -X GET 'https://api.tolt.com/v1/commissions?program_id=prg_YRsbPDAKhWfdqJbFACheh' \
-H 'Authorization: Bearer <API_KEY>'

curl -X GET 'https://api.tolt.com/v1/commissions?program_id=prg_YRsbPDAKhWfdqJbFACheh&expand[]=partner&expand[]=program&expand[]=customer&expand[]=transaction' \
-H 'Authorization: Bearer <API_KEY>'

{
  "success": true,
  "has_more": true,
  "total_count": 45,
  "data": [
    {
      "id": "comm_eK9bzRGn46BhVgNFHD6fDgXW",
      "amount": 1999,
      "customer_id": "cust_dK9bzRGn46BhVgNFHD6fDgXW",
      "transaction_id": "txn_7mbzRGn46BhVgNFHD6fDgXW",
      "charge_id": "ch_9bzRGn46BhVgNFHD6fDgXW",
      "source": "stripe",
      "status": "pending",
      "revenue": 9999,
      "created_at": "2025-01-15T14:30:00.000Z",
      "updated_at": "2025-01-15T14:30:00.000Z",
      "program_id": "prg_YRsbPDAKhWfdqJbFACheh",
      "organization_id": "org_JE3mfYNL9ci7sFaJazAv2"
    }
  ]
}

{
  "success": true,
  "has_more": true,
  "total_count": 45,
  "data": [
    {
      "id": "comm_eK9bzRGn46BhVgNFHD6fDgXW",
      "amount": 1999,
      "customer_id": "cust_dK9bzRGn46BhVgNFHD6fDgXW",
      "transaction_id": "txn_7mbzRGn46BhVgNFHD6fDgXW",
      "charge_id": "ch_9bzRGn46BhVgNFHD6fDgXW",
      "source": "stripe",
      "status": "pending",
      "revenue": 9999,
      "created_at": "2025-01-15T14:30:00.000Z",
      "updated_at": "2025-01-15T14:30:00.000Z",
      "program_id": "prg_YRsbPDAKhWfdqJbFACheh",
      "organization_id": "org_JE3mfYNL9ci7sFaJazAv2",
      "partner": {
        "id": "part_s7mbzRGn46BhVgNFHD6fDgXW",
        "first_name": "Michael",
        "last_name": "Scott",
        "email": "michael.scott@dundermifflin.com",
        "company_name": "Dunder Mifflin",
        "status": "active",
        "created_at": "2025-01-13T10:06:11.251Z"
      },
      "program": {
        "id": "prg_YRsbPDAKhWfdqJbFACheh",
        "status": "active",
        "name": "Tolt's Partnership Program",
        "product_name": "Tolt",
        "subdomain": "affiliates",
        "type": "public",
        "currency_code": "USD",
        "created_at": "2024-03-05T10:28:08.984+00:00"
      },
      "customer": {
        "id": "cust_dK9bzRGn46BhVgNFHD6fDgXW",
        "email": "cust_123",
        "name": "Jim Halpert",
        "status": "active",
        "created_at": "2025-01-15T14:30:00.000Z"
      },
      "transaction": {
        "id": "txn_7mbzRGn46BhVgNFHD6fDgXW",
        "amount": 9999,
        "status": "completed",
        "created_at": "2025-01-15T14:30:00.000Z"
      }
    }
  ]
}

GET

commissions

curl -X GET 'https://api.tolt.com/v1/commissions?program_id=prg_YRsbPDAKhWfdqJbFACheh' \
-H 'Authorization: Bearer <API_KEY>'

curl -X GET 'https://api.tolt.com/v1/commissions?program_id=prg_YRsbPDAKhWfdqJbFACheh&expand[]=partner&expand[]=program&expand[]=customer&expand[]=transaction' \
-H 'Authorization: Bearer <API_KEY>'

{
  "success": true,
  "has_more": true,
  "total_count": 45,
  "data": [
    {
      "id": "comm_eK9bzRGn46BhVgNFHD6fDgXW",
      "amount": 1999,
      "customer_id": "cust_dK9bzRGn46BhVgNFHD6fDgXW",
      "transaction_id": "txn_7mbzRGn46BhVgNFHD6fDgXW",
      "charge_id": "ch_9bzRGn46BhVgNFHD6fDgXW",
      "source": "stripe",
      "status": "pending",
      "revenue": 9999,
      "created_at": "2025-01-15T14:30:00.000Z",
      "updated_at": "2025-01-15T14:30:00.000Z",
      "program_id": "prg_YRsbPDAKhWfdqJbFACheh",
      "organization_id": "org_JE3mfYNL9ci7sFaJazAv2"
    }
  ]
}

{
  "success": true,
  "has_more": true,
  "total_count": 45,
  "data": [
    {
      "id": "comm_eK9bzRGn46BhVgNFHD6fDgXW",
      "amount": 1999,
      "customer_id": "cust_dK9bzRGn46BhVgNFHD6fDgXW",
      "transaction_id": "txn_7mbzRGn46BhVgNFHD6fDgXW",
      "charge_id": "ch_9bzRGn46BhVgNFHD6fDgXW",
      "source": "stripe",
      "status": "pending",
      "revenue": 9999,
      "created_at": "2025-01-15T14:30:00.000Z",
      "updated_at": "2025-01-15T14:30:00.000Z",
      "program_id": "prg_YRsbPDAKhWfdqJbFACheh",
      "organization_id": "org_JE3mfYNL9ci7sFaJazAv2",
      "partner": {
        "id": "part_s7mbzRGn46BhVgNFHD6fDgXW",
        "first_name": "Michael",
        "last_name": "Scott",
        "email": "michael.scott@dundermifflin.com",
        "company_name": "Dunder Mifflin",
        "status": "active",
        "created_at": "2025-01-13T10:06:11.251Z"
      },
      "program": {
        "id": "prg_YRsbPDAKhWfdqJbFACheh",
        "status": "active",
        "name": "Tolt's Partnership Program",
        "product_name": "Tolt",
        "subdomain": "affiliates",
        "type": "public",
        "currency_code": "USD",
        "created_at": "2024-03-05T10:28:08.984+00:00"
      },
      "customer": {
        "id": "cust_dK9bzRGn46BhVgNFHD6fDgXW",
        "email": "cust_123",
        "name": "Jim Halpert",
        "status": "active",
        "created_at": "2025-01-15T14:30:00.000Z"
      },
      "transaction": {
        "id": "txn_7mbzRGn46BhVgNFHD6fDgXW",
        "amount": 9999,
        "status": "completed",
        "created_at": "2025-01-15T14:30:00.000Z"
      }
    }
  ]
}

Base URL `https://api.tolt.com`

Query Parameters

string

The program ID from where you want to list the commissions

string - optional

Only return commissions from this partner

string - optional

Only return commissions for this customer

string - optional

Only return commissions for this transaction

asc | desc - optional

The order of the commissions to return by created_at. Default is desc

array - optional

Specify which related objects to include in the response. Valid values are ‘partner’, ‘program’, ‘customer’, and ‘transaction’. Use expand[]=partner, expand[]=program, expand[]=customer, or expand[]=transaction to include the related objects.

string - optional

Only return commissions created after this date

string - optional

Only return commissions created before this date

string - optional

A limit on the number of commissions to return. Default is 10, max is 100

string - optional

A cursor for use in pagination. starting_after is an object ID that defines your place in the list

string - optional

A cursor for use in pagination. ending_before is an object ID that defines your place in the list

Response

boolean

Whether the request was successful

boolean

Whether there are more pages of results available

integer

Total number of commissions matching the query

array[Object]

Show properties

string

Unique identifier for the commission

number

Commission amount in cents

string

ID of the associated customer

string

Associated transaction identifier

string

Associated charge identifier

string

Source of the commission

string

Commission status

number

Revenue amount in cents

string

ISO 8601 timestamp of creation

string

ISO 8601 timestamp of update

string

Program ID the commission belongs to

string

Organization ID

curl -X GET 'https://api.tolt.com/v1/commissions?program_id=prg_YRsbPDAKhWfdqJbFACheh' \
-H 'Authorization: Bearer <API_KEY>'

curl -X GET 'https://api.tolt.com/v1/commissions?program_id=prg_YRsbPDAKhWfdqJbFACheh&expand[]=partner&expand[]=program&expand[]=customer&expand[]=transaction' \
-H 'Authorization: Bearer <API_KEY>'

{
  "success": true,
  "has_more": true,
  "total_count": 45,
  "data": [
    {
      "id": "comm_eK9bzRGn46BhVgNFHD6fDgXW",
      "amount": 1999,
      "customer_id": "cust_dK9bzRGn46BhVgNFHD6fDgXW",
      "transaction_id": "txn_7mbzRGn46BhVgNFHD6fDgXW",
      "charge_id": "ch_9bzRGn46BhVgNFHD6fDgXW",
      "source": "stripe",
      "status": "pending",
      "revenue": 9999,
      "created_at": "2025-01-15T14:30:00.000Z",
      "updated_at": "2025-01-15T14:30:00.000Z",
      "program_id": "prg_YRsbPDAKhWfdqJbFACheh",
      "organization_id": "org_JE3mfYNL9ci7sFaJazAv2"
    }
  ]
}

{
  "success": true,
  "has_more": true,
  "total_count": 45,
  "data": [
    {
      "id": "comm_eK9bzRGn46BhVgNFHD6fDgXW",
      "amount": 1999,
      "customer_id": "cust_dK9bzRGn46BhVgNFHD6fDgXW",
      "transaction_id": "txn_7mbzRGn46BhVgNFHD6fDgXW",
      "charge_id": "ch_9bzRGn46BhVgNFHD6fDgXW",
      "source": "stripe",
      "status": "pending",
      "revenue": 9999,
      "created_at": "2025-01-15T14:30:00.000Z",
      "updated_at": "2025-01-15T14:30:00.000Z",
      "program_id": "prg_YRsbPDAKhWfdqJbFACheh",
      "organization_id": "org_JE3mfYNL9ci7sFaJazAv2",
      "partner": {
        "id": "part_s7mbzRGn46BhVgNFHD6fDgXW",
        "first_name": "Michael",
        "last_name": "Scott",
        "email": "michael.scott@dundermifflin.com",
        "company_name": "Dunder Mifflin",
        "status": "active",
        "created_at": "2025-01-13T10:06:11.251Z"
      },
      "program": {
        "id": "prg_YRsbPDAKhWfdqJbFACheh",
        "status": "active",
        "name": "Tolt's Partnership Program",
        "product_name": "Tolt",
        "subdomain": "affiliates",
        "type": "public",
        "currency_code": "USD",
        "created_at": "2024-03-05T10:28:08.984+00:00"
      },
      "customer": {
        "id": "cust_dK9bzRGn46BhVgNFHD6fDgXW",
        "email": "cust_123",
        "name": "Jim Halpert",
        "status": "active",
        "created_at": "2025-01-15T14:30:00.000Z"
      },
      "transaction": {
        "id": "txn_7mbzRGn46BhVgNFHD6fDgXW",
        "amount": 9999,
        "status": "completed",
        "created_at": "2025-01-15T14:30:00.000Z"
      }
    }
  ]
}

tolt.js

Guides / How To

Programs

Partners

Customers

Clicks

Links

Commissions

Transactions

Promotion Codes

Base URL `https://api.tolt.com`

Query Parameters

Response

​Base URL https://api.tolt.com

​Query Parameters

​Response

Base URL `https://api.tolt.com`

Query Parameters

Response