GET
/
payouts
/
due_stats
Get due payout stats
curl --request GET \
  --url https://v2.firstpromoter.com/api/v2/company/payouts/due_stats \
  --header 'Account-ID: <account-id>' \
  --header 'Authorization: Bearer <token>'
{
  "meta": {
    "net_payout_days": 123,
    "payout_cycle": "<string>",
    "min_payment": 123,
    "min_paying_customers": 123,
    "terms_description": "<string>",
    "selected_payout_methods": [
      "<string>"
    ],
    "payout_method_options": {},
    "managed_payouts": true
  },
  "data": {
    "next": {
      "promoters_count": 123,
      "amounts": {},
      "total_incl_tax": 123,
      "due_date": "2023-12-25",
      "period_end": "2023-12-25"
    },
    "overdue": {
      "promoters_count": 123,
      "amounts": {},
      "total_incl_tax": 123,
      "due_date": "2023-12-25",
      "period_end": "2023-12-25"
    },
    "custom": {
      "promoters_count": 123,
      "amounts": {},
      "total_incl_tax": 123
    }
  }
}

Authorizations

​
Authorization
string
header
required

Access token passed as a Bearer token in the Authorization header

Headers

​
Account-ID
string
required

Account identifier that specifies which account is making the request

Example:

"acc_123456"

Query Parameters

​
q
string

Search params. Searches by 'promoter.profile.first_name,promoter.profile.last_name,promoter.user.email`

​
filters[status]
enum<string>

Filter by status

Available options:
pending,
completed,
failed,
processing,
cancelled
​
filters[campaign_id]

Campaign ids. Can be Integer or Array of Integers

Response

200
application/json

Successful response

The response is of type object.