Customers
With Rebill's Customers API, you can access the whole information and also manually edit specific data of your customers.
GET/v2/customers
Get customers
Get the list of all your customers.
Optional Query Parameters
order
stringsearch
stringpage
stringtake
jsonLoading...
Response
{
"data": [
{
"id": "example-id-1234",
"firstName": "John",
"lastName": "Doe",
"cellPhone": "56-12345678",
"birthday": "1980-01-01",
"taxIdType": "SSN",
"taxIdNumber": "123-45-6789",
"personalIdType": "DNI",
"personalIdNumber": "987654321",
"userEmail": "johndoe@example.com",
"cards": [],
"address": {
"street": "Main Street",
"city": "Example City",
"state": "State",
"country": "Country",
"zipCode": "12345",
"number": "100",
"floor": "2",
"apt": "B",
"description": "Near central park"
},
"createdAt": "2024-01-01T10:00:00.000Z"
},
// more customers...
]
}
GET/v2/customers/{email}/detail
Get customer by email
Retrieve detailed information about a specific customer.
Required Path Parameters
email
stringrequiredLoading...
Response
{
"id": "example-id-1234",
"firstName": "John",
"lastName": "Doe",
"cellPhone": "56-12345678",
"birthday": "1980-01-01",
"taxIdType": "SSN",
"taxIdNumber": "123-45-6789",
"personalIdType": "DNI",
"personalIdNumber": "987654321",
"userEmail": "johndoe@example.com",
"cards": [],
"address": {
"street": "Main Street",
"city": "Example City",
"state": "State",
"country": "Country",
"zipCode": "12345",
"number": "100",
"floor": "2",
"apt": "B",
"description": "Near central park"
},
"createdAt": "2024-01-01T10:00:00.000Z"
}
POST/v2/customers
Create a customer
Create a new customer with one or more cards associated.
You may only send card information through this endpoint if you are PCI Compliant. If you aren't, you can create a new customer with an empty card array, or you may use our SDK to securely collect card information in the checkout.
Required Body Parameters
user
objectrequiredprofile
objectrequiredcards
array of objectsrequiredLoading...
Response
{
"id": "example-id-1234",
"firstName": "John",
"lastName": "Doe",
"cellPhone": "56-12345678",
"birthday": "1980-01-01",
"taxIdType": "SSN",
"taxIdNumber": "123-45-6789",
"personalIdType": "DNI",
"personalIdNumber": "987654321",
"userEmail": "johndoe@example.com",
"cards": [],
"address": {
"street": "Main Street",
"city": "Example City",
"state": "State",
"country": "Country",
"zipCode": "12345",
"number": "100",
"floor": "2",
"apt": "B",
"description": "Near central park"
},
"createdAt": "2024-01-01T10:00:00.000Z"
}
PUT/v2/customers/{customerId}/profile
Update a customer's profile
Use this endpoint to update a specified customer profile with the provided information. Parameters not sent in the payload will be left unchanged.
Required Path Parameters
customerId
stringrequiredOptional Body Parameters
firstName
stringlastName
stringphone
objectbirthday
datetimetaxId
objectaddress
objectemail
stringLoading...
Response
{
"firstName": "John",
"lastName": "Doe",
"phone": {
"countryCode": "54",
"areaCode": "11",
"phoneNumber": "12348765"
},
"birthday": "1989-01-15",
"taxId": {
"type": "CUIT",
"value": "20940000019"
},
"personalId": {
"type": "DNI",
"value": "94000001"
},
"address": {
"street": "Riverside St.",
"city": "New York City",
"state": "FL",
"country": "USA",
"zipCode": "90210",
"number": "102",
"floor": "2",
"apt": "B",
"description": "Home / Office"
}
}