Skip to main content
A Customer represents a business or individual that purchases your products or services. It allows you to track subscriptions, payments, invoices, and usage for a specific entity.

👤 Creating a Customer

You should create a Customer in Credibill when a user signs up for your application. This endpoint is used to register a new customer in the system. It is authenticated via an API Key passed as a Bearer Token in the Authorization header.
  • Endpoint: https://giant-goldfish-922.convex.site/api/v1/customers/create
  • Method: POST
  • Authentication: Authorization: Bearer <CREDIBILL_API_KEY>
Request Body Schema:

Example (React + TS)

Response

When you create a customer, the API responds with a JSON object containing the success status and the unique customer ID.

Getting Customer Details

Retrieve customer information by listing all customers for your app or fetching a specific customer by ID.
  • Endpoint: https://giant-goldfish-922.convex.site/api/customers
  • Method: GET
  • Authentication: Authorization: Bearer <CREDIBILL_API_KEY>

Query Parameters

Examples

Response Examples

Get Single Customer:
List All Customers: