Get average payment period

GET

reports

average_payment_period

curl --request GET \
  --url https://api.staging.streamlinedpayments.com/api/v1/reports/average_payment_period \
  --header 'X-Api-Key: <api-key>' \
  --header 'X-App-Id: <api-key>'

const options = {method: 'GET', headers: {'X-App-Id': '<api-key>', 'X-Api-Key': '<api-key>'}};

fetch('https://api.staging.streamlinedpayments.com/api/v1/reports/average_payment_period', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.staging.streamlinedpayments.com/api/v1/reports/average_payment_period"

headers = {
    "X-App-Id": "<api-key>",
    "X-Api-Key": "<api-key>"
}

response = requests.get(url, headers=headers)

print(response.text)

require 'uri'
require 'net/http'

url = URI("https://api.staging.streamlinedpayments.com/api/v1/reports/average_payment_period")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-App-Id"] = '<api-key>'
request["X-Api-Key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "data": [
    {
      "month": "2026-10",
      "average_days_to_pay": 34,
      "median_days_to_pay": 21,
      "paid_invoice_count": 6
    }
  ]
}

Authorizations

X-App-Id

string

header

required

App ID for authentication

X-Api-Key

string

header

required

API Key for authentication

Query Parameters

start_date

string<date>

First month of the range, as any day in it (YYYY-MM-DD). The range can be at most 24 months.

end_date

string<date>

Last month of the range, as any day in it (YYYY-MM-DD).

Response

Successful operation

data

object[]

Every month in the range, oldest first.

Show child attributes

Get average payment period

curl --request GET \
  --url https://api.staging.streamlinedpayments.com/api/v1/reports/average_payment_period \
  --header 'X-Api-Key: <api-key>' \
  --header 'X-App-Id: <api-key>'

const options = {method: 'GET', headers: {'X-App-Id': '<api-key>', 'X-Api-Key': '<api-key>'}};

fetch('https://api.staging.streamlinedpayments.com/api/v1/reports/average_payment_period', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.staging.streamlinedpayments.com/api/v1/reports/average_payment_period"

headers = {
    "X-App-Id": "<api-key>",
    "X-Api-Key": "<api-key>"
}

response = requests.get(url, headers=headers)

print(response.text)

require 'uri'
require 'net/http'

url = URI("https://api.staging.streamlinedpayments.com/api/v1/reports/average_payment_period")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-App-Id"] = '<api-key>'
request["X-Api-Key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "data": [
    {
      "month": "2026-10",
      "average_days_to_pay": 34,
      "median_days_to_pay": 21,
      "paid_invoice_count": 6
    }
  ]
}

Orders

Customers

Customer applications

Customer groups

Customer files

Customer addresses

Payouts

Invoices

Transactions

Products

Deposit links

Webhooks

Reports

Get average payment period

Authorizations

Query Parameters

Response