UseePay API
  1. Customers
UseePay API
  • Introduction
  • Product Overview
  • Authentication
  • Errors
  • Changelog
  • Integration
    • Get started with online payments
    • Get started with subscriptions
  • Payment Intents
    • Create a PaymentIntent
      POST
    • Retrieve a PaymentIntent
      GET
    • Update a PaymentIntent
      POST
    • Confirm a PaymentIntent
      POST
    • Cancel a PaymentIntent
      POST
    • Capture a PaymentIntent
      POST
    • List all payment intents
      GET
  • Customers
    • Create a customer
      POST
    • Retrieves a customer
      GET
    • Update a customer
      POST
    • List all customers
      GET
  • Subscriptions
    • Create a subscription
      POST
    • Retrieves a subscription
      GET
    • Update a subscription
      POST
    • List all subscriptions
      GET
    • Cancel a subscription
      POST
  • Invoices
    • Create a invoice
      POST
    • Retrieves a invoice
      GET
    • Update a invoice
      POST
    • List all invoices
      GET
    • Pay a invoice
      POST
  • Payment Methods
    • Create a payment method
    • Retrieves a payment method
    • Update a payment method
    • List all payment methods
  • Mandates
    • Create a mandate
    • Retrieves a mandate
    • Update a mandate
    • List all mandates
  • Refunds
    • Create a refund
    • Retrieves a refund
    • Update a refund
    • List all refunds
  • Webhooks
    • Webhook envents
    • Create a webhook
    • Retrieves a webhook
    • Update a webhook
    • List all webhooks
  • Payment Links
    • Create a payment link
    • Retrieves a payment link
    • Update a payment link
    • List all payment links
  • Embedded Checkout
    • Payment Elements
  • About Testing
    • Test Cards
    • ApplePay&GooglePay
  1. Customers

List all customers

GET
/api/v1/customers

Request

Query Params

Header Params

Request samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://openapi1.uat.useepay.com/api/v1/customers?page_num=0&page_size=3&from_created_at=2024-09-29T07:44:50.774Z&email&merchant_customer_id' \
--header 'x-merchant-no: 500000000007245' \
--header 'x-api-key: FUYTIUvjhgfytfuytwiue' \
--header 'x-app-id: www.pay.com'

Responses

🟢200Success
application/json
Body

Example
{
    "items": [
        {
            "id": "cus_1J6N9TPUSIG00",
            "address": {
                "country": "CN",
                "city": "shanghai",
                "postcode": "200100",
                "state": "shanghai",
                "line1": "pudong zhangjiang",
                "line2": "room 1002"
            },
            "description": "test customer",
            "name": "eric.wang",
            "email": "eric.wang@useepay.com",
            "phone": "13527156763",
            "metadata": {
                "testkey": "12233"
            },
            "shipping": {
                "address": {
                    "country": "CN",
                    "city": "shanghai",
                    "postcode": "200100",
                    "state": "shanghai",
                    "line1": "minghang pushenglu",
                    "line2": "room 2002"
                },
                "name": "zhangsan",
                "phone": "13527189021",
                "first_name": null,
                "last_name": null,
                "shipping_method": null
            },
            "merchant_no": "500000000007264",
            "app_id": "www.pay.com",
            "create_at": "2024-10-12T10:09:53Z",
            "modify_at": "2024-10-12T10:09:53Z",
            "first_name": null,
            "last_name": null,
            "merchant_customer_id": "1000000021134"
        },
        {
            "id": "cus_1JA7K18HS1K00",
            "address": {
                "country": "CN",
                "city": "shanghai",
                "postcode": "200100",
                "state": "shanghai",
                "line1": "pudong zhangjiang",
                "line2": "room 1002"
            },
            "description": "test customer",
            "name": "eric.wang",
            "email": "eric.wang@useepay.com",
            "phone": "13527156763",
            "metadata": {
                "testkey": "12233"
            },
            "shipping": {
                "address": {
                    "country": "CN",
                    "city": "shanghai",
                    "postcode": "200100",
                    "state": "shanghai",
                    "line1": "minghang pushenglu",
                    "line2": "room 2002"
                },
                "name": "zhangsan",
                "phone": "13527189021",
                "first_name": null,
                "last_name": null,
                "shipping_method": null
            },
            "merchant_no": "500000000007264",
            "app_id": "www.pay.com",
            "create_at": "2024-10-23T07:52:46Z",
            "modify_at": "2024-10-23T07:52:46Z",
            "first_name": null,
            "last_name": null,
            "merchant_customer_id": "1000000021135"
        },
        {
            "id": "cus_1JA7PLHNS3800",
            "address": {
                "country": "CN",
                "city": "shanghai",
                "postcode": "200100",
                "state": "shanghai",
                "line1": "pudong zhangjiang",
                "line2": "room 1002"
            },
            "description": "test customer",
            "name": "zhangsan",
            "email": "zhangsan@useepay.com",
            "phone": "134251756712",
            "metadata": {
                "testkey": "12233"
            },
            "shipping": {
                "address": {
                    "country": "CN",
                    "city": "shanghai",
                    "postcode": "200100",
                    "state": "shanghai",
                    "line1": "minghang pushenglu",
                    "line2": "room 2002"
                },
                "name": "SHI-zhangsan",
                "phone": "13527189021",
                "first_name": null,
                "last_name": null,
                "shipping_method": null
            },
            "merchant_no": "500000000007264",
            "app_id": "www.pay.com",
            "create_at": "2024-10-23T08:17:23Z",
            "modify_at": "2024-10-23T08:18:05Z",
            "first_name": "zhang",
            "last_name": null,
            "merchant_customer_id": "1000000021136"
        }
    ],
    "has_more": true
}
Modified at 2025-04-30 07:52:50
Previous
Update a customer
Next
Create a subscription
Built with