List by Merchant

curl --request GET \
  --url https://api.paygentic.io/v0/customers \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.paygentic.io/v0/customers', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.paygentic.io/v0/customers",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.paygentic.io/v0/customers"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.paygentic.io/v0/customers")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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

{
  "object": "list",
  "data": [
    {
      "id": "cus_p1q2r3s4t5u6v7w8",
      "object": "customer",
      "consumerId": "org_x9y0z1a2b3c4d5e6",
      "createdAt": "2024-02-05T11:30:00Z",
      "merchantId": "org_f7g8h9i0j1k2l3m4",
      "organization": {
        "id": "org_x9y0z1a2b3c4d5e6",
        "address": {
          "city": "San Francisco",
          "country": "US",
          "line1": "123 Main St",
          "state": "CA",
          "zipCode": "94105"
        },
        "billingEmails": [
          "billing@techcorp.com"
        ],
        "name": "TechCorp",
        "phone": "+1-555-123-4567"
      },
      "taxId": null,
      "taxRates": {
        "default": 8.5
      },
      "updatedAt": "2024-02-10T14:20:00Z",
      "validTaxAddress": {
        "message": null,
        "valid": true
      }
    }
  ],
  "pagination": {
    "limit": 10,
    "offset": 0,
    "total": 1
  }
}

{
  "message": "The requested resource was not found",
  "error": "not_found"
}

{
  "message": "The requested resource was not found",
  "error": "not_found"
}

{
  "message": "The requested resource was not found",
  "error": "not_found"
}

{
  "message": "The requested resource was not found",
  "error": "not_found"
}

GET

customers

List by Merchant

curl --request GET \
  --url https://api.paygentic.io/v0/customers \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.paygentic.io/v0/customers', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.paygentic.io/v0/customers",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.paygentic.io/v0/customers"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.paygentic.io/v0/customers")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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

{
  "object": "list",
  "data": [
    {
      "id": "cus_p1q2r3s4t5u6v7w8",
      "object": "customer",
      "consumerId": "org_x9y0z1a2b3c4d5e6",
      "createdAt": "2024-02-05T11:30:00Z",
      "merchantId": "org_f7g8h9i0j1k2l3m4",
      "organization": {
        "id": "org_x9y0z1a2b3c4d5e6",
        "address": {
          "city": "San Francisco",
          "country": "US",
          "line1": "123 Main St",
          "state": "CA",
          "zipCode": "94105"
        },
        "billingEmails": [
          "billing@techcorp.com"
        ],
        "name": "TechCorp",
        "phone": "+1-555-123-4567"
      },
      "taxId": null,
      "taxRates": {
        "default": 8.5
      },
      "updatedAt": "2024-02-10T14:20:00Z",
      "validTaxAddress": {
        "message": null,
        "valid": true
      }
    }
  ],
  "pagination": {
    "limit": 10,
    "offset": 0,
    "total": 1
  }
}

{
  "message": "The requested resource was not found",
  "error": "not_found"
}

{
  "message": "The requested resource was not found",
  "error": "not_found"
}

{
  "message": "The requested resource was not found",
  "error": "not_found"
}

{
  "message": "The requested resource was not found",
  "error": "not_found"
}

Authorizations

Authorization

string

header

required

API key authentication

Query Parameters

limit

integer

default:10

Number of customers to return

Required range: 1 <= x <= 100

offset

integer

default:0

Number of customers to skip

Required range: x >= 0

name

string

Filter customers by consumer name (case-insensitive substring match). Minimum 3 characters required for efficient index usage.

Required string length: 3 - 255

string

Filter customers by billing email (case-insensitive substring match). Minimum 3 characters required for efficient index usage. Accepts partial values — e.g. a domain ("acme.com") or local part ("billing").

Required string length: 3 - 255

externalId

string

Filter customers by exact external ID match.

Maximum string length: 255

organizationId

string

required

ID of the merchant organization to filter customers by Unique identifier for an organization

Pattern: ^org_[a-zA-Z0-9]+$

Response

List of customers retrieved successfully

object

enum<string>

required

Available options:

list

data

object[]

required

Show child attributes

pagination

object

required

Offset-based pagination response.

Show child attributes

Billable Metrics

Customers

Entitlements

Grants

Features

Fees

Plans

Prices

Products

Sources

Subscriptions

Users

Invoices V2

Payments

Payment Sessions

Events

Costs

Revenue

Profitability

Test Clocks

ExternalReferences

Items

Orders

Billing Schedules

Salesforce

MerchantIntegrations

Approvals

List by Merchant

Authorizations

Query Parameters

Response