API Reference
- GETGet Customer
- PATCHEdit Customer
- GETGet Customer Payment Methods
- GETGet Payment Method Setup Secret
- GETList Customers
- POSTInitialize customer
- POSTPush customer custom event.
- GETGet invoicing schedule
- POSTGenerate mandate signature request
- PUTUpdate customer preferred payment method
- PUTUpdate customer payment mode
- GETGet bank transfer account
- POSTAttempt a charge for an invoice
- GETGet Customer Balance
- GET
{
"data": [
{
"metadata": [
{
"key": "<string>",
"value": "<string>"
}
],
"type": "<string>",
"id": "<string>",
"status": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"paymentMethodType": "card",
"isPreferred": true,
"mandateDocumentId": "<string>",
"last4": "<string>",
"expirationMonth": 123,
"expirationYear": 123,
"billingDetails": {
"name": "<string>",
"email": "<string>",
"phone": "<string>",
"address": {
"city": "<string>",
"country": "<string>",
"line1": "<string>",
"line2": "<string>",
"postalCode": "<string>",
"state": "<string>"
}
}
}
],
"total": 123,
"offset": 123,
"limit": 123
}Get Customer Payment Methods
{
"data": [
{
"metadata": [
{
"key": "<string>",
"value": "<string>"
}
],
"type": "<string>",
"id": "<string>",
"status": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"paymentMethodType": "card",
"isPreferred": true,
"mandateDocumentId": "<string>",
"last4": "<string>",
"expirationMonth": 123,
"expirationYear": 123,
"billingDetails": {
"name": "<string>",
"email": "<string>",
"phone": "<string>",
"address": {
"city": "<string>",
"country": "<string>",
"line1": "<string>",
"line2": "<string>",
"postalCode": "<string>",
"state": "<string>"
}
}
}
],
"total": 123,
"offset": 123,
"limit": 123
}Path Parameters
The customer id
Query Parameters
Optional: the whenAt datetime
Optional: the simulatedAt datetime
Optional: the branchId
Response
Array of payment methods
Show child attributes
Show child attributes
the id of the payment method
the date of creation of the stripe customer
the date of creation of the stripe customer
the type of the payment method
card, sepa_debit Is the preferred payment method
the document id of the mandate, if applicable
the last 4 digits of the payment method, if applicable
the expiration month of payment method, if applicable
the expiration year of payment method, if applicable
the billing details of payment method, if applicable
Show child attributes
Show child attributes
the name of the billing details
the email of the billing details
the phone of the billing details
the address of the billing details
Show child attributes
Show child attributes
the city of the billing address
the country of the billing address
the line1 of the billing address
the line2 of the billing address
the postal code of the billing address
the state of the billing address
Optional: Total number of payment methods
Optional: Number of payment methods the array has to star after
Optional: Number of payment methods in the array
Was this page helpful?