Payments
List Payments
GET
/
api
/
v1
/
payments
curl --request GET \
--url https://app.flowglad.com/api/v1/payments \
--header 'Authorization: <api-key>'
{
"data": [
{
"id": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"createdByCommit": "<string>",
"updatedByCommit": "<string>",
"invoiceId": "<string>",
"amount": 123,
"paymentMethod": "card",
"currency": "USD",
"status": "canceled",
"chargeDate": "2023-11-07T05:31:56Z",
"settlementDate": "2023-11-07T05:31:56Z",
"description": "<string>",
"receiptNumber": "<string>",
"receiptURL": "<string>",
"customerId": "<string>",
"purchaseId": "<string>",
"subscriptionId": "<string>",
"paymentMethodId": "<string>",
"billingPeriodId": "<string>",
"taxAmount": 123,
"subtotal": 123,
"taxType": "amusement_tax",
"taxCountry": "AF",
"taxState": "<string>",
"taxRatePercentage": "<string>",
"applicationFee": 123,
"refunded": true,
"refundedAmount": 123,
"refundedAt": "2023-11-07T05:31:56Z",
"failureMessage": "<string>",
"failureCode": "<string>"
}
],
"currentCursor": "<string>",
"nextCursor": "<string>",
"hasMore": true,
"total": 123
}
Authorizations
Response
200
application/json
Successful response
The response is of type object
.
curl --request GET \
--url https://app.flowglad.com/api/v1/payments \
--header 'Authorization: <api-key>'
{
"data": [
{
"id": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"createdByCommit": "<string>",
"updatedByCommit": "<string>",
"invoiceId": "<string>",
"amount": 123,
"paymentMethod": "card",
"currency": "USD",
"status": "canceled",
"chargeDate": "2023-11-07T05:31:56Z",
"settlementDate": "2023-11-07T05:31:56Z",
"description": "<string>",
"receiptNumber": "<string>",
"receiptURL": "<string>",
"customerId": "<string>",
"purchaseId": "<string>",
"subscriptionId": "<string>",
"paymentMethodId": "<string>",
"billingPeriodId": "<string>",
"taxAmount": 123,
"subtotal": 123,
"taxType": "amusement_tax",
"taxCountry": "AF",
"taxState": "<string>",
"taxRatePercentage": "<string>",
"applicationFee": 123,
"refunded": true,
"refundedAmount": 123,
"refundedAt": "2023-11-07T05:31:56Z",
"failureMessage": "<string>",
"failureCode": "<string>"
}
],
"currentCursor": "<string>",
"nextCursor": "<string>",
"hasMore": true,
"total": 123
}
Assistant
Responses are generated using AI and may contain mistakes.