Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.stellartools.dev/llms.txt

Use this file to discover all available pages before exploring further.

A customer represents a person or entity that pays through StellarTools. Customers hold wallets, subscriptions, and payment history.

​
The customer object

​
id
string
Unique identifier. Prefixed with cus_.
​
object
string
Always "customer".
​
email
string
Email address of the customer.
​
name
string
Full name of the customer.
​
phone
string
Phone number of the customer.
​
image
string
URL to the customer’s profile image.
​
wallets
array
Stellar wallets linked to this customer.
​
metadata
object
Arbitrary key-value data you can attach to the customer.
​
created_at
string
ISO 8601 timestamp.
​
updated_at
string
ISO 8601 timestamp.

​
Create a customer

POST /customers Creates one customer. You can also pass an array to create multiple at once. 
curl https://api.stellartools.dev/customers \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "email": "jane@example.com", "name": "Jane Smith" }'

​
Body

​
email
string
required
Customer’s email address.
​
name
string
required
Customer’s full name.
​
phone
string
Customer’s phone number.
​
image
string
URL to a profile image.
​
metadata
object
Arbitrary key-value string pairs to attach to the customer.

​
List customers

GET /customers Returns all customers for your account. 
curl https://api.stellartools.dev/customers \
  -H "x-api-key: YOUR_API_KEY"
Returns a list object containing customer objects.

​
Retrieve a customer

GET /customers/{customer_id} 
curl https://api.stellartools.dev/customers/cus_01jx... \
  -H "x-api-key: YOUR_API_KEY"

​
Update a customer

PUT /customers/{customer_id} 
curl -X PUT https://api.stellartools.dev/customers/cus_01jx... \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "name": "Jane Doe" }'

​
Body

​
email
string
New email address.
​
name
string
New name.
​
phone
string
New phone number.
​
image
string
New image URL.
​
metadata
object
Merged with existing metadata.

​
Delete a customer

DELETE /customers/{customer_id} Returns null on success. 
curl -X DELETE https://api.stellartools.dev/customers/cus_01jx... \
  -H "x-api-key: YOUR_API_KEY"