API Documentation
Transactions
curl --request GET \
--url https://api.creem.io/v1/transactions/search \
--header 'x-api-key: <x-api-key>'{
"items": [
{
"id": "<string>",
"mode": "test",
"object": "transaction",
"amount": 2000,
"currency": "USD",
"type": "<string>",
"status": "<string>",
"created_at": 123,
"amount_paid": 2000,
"discount_amount": 2000,
"tax_country": "US",
"tax_amount": 2000,
"refunded_amount": 2000,
"order": "<string>",
"subscription": "<string>",
"customer": "<string>",
"description": "<string>",
"period_start": 123,
"period_end": 123
}
],
"pagination": {
"total_records": 0,
"total_pages": 0,
"current_page": 1,
"next_page": 2,
"prev_page": null
}
}List Transactions
Search and retrieve payment transactions. Filter by customer, product, date range, and status.
curl --request GET \
--url https://api.creem.io/v1/transactions/search \
--header 'x-api-key: <x-api-key>'{
"items": [
{
"id": "<string>",
"mode": "test",
"object": "transaction",
"amount": 2000,
"currency": "USD",
"type": "<string>",
"status": "<string>",
"created_at": 123,
"amount_paid": 2000,
"discount_amount": 2000,
"tax_country": "US",
"tax_amount": 2000,
"refunded_amount": 2000,
"order": "<string>",
"subscription": "<string>",
"customer": "<string>",
"description": "<string>",
"period_start": 123,
"period_end": 123
}
],
"pagination": {
"total_records": 0,
"total_pages": 0,
"current_page": 1,
"next_page": 2,
"prev_page": null
}
}Headers
Query Parameters
The customer id
The order id
The product id
The page number
The the page size
Response
Successfully retrieved transactions
List of transactions items
Show child attributes
Show child attributes
Unique identifier for the object.
String representing the environment.
test, prod, sandbox String representing the object's type. Objects of the same type share the same value.
"transaction"
The transaction amount in cents. 1000 = $10.00
2000
Three-letter ISO currency code, in uppercase. Must be a supported currency.
"USD"
The type of transaction. payment(one time payments) and invoice(subscription)
Status of the transaction.
Creation date of the order as timestamp
The amount the customer paid in cents. 1000 = $10.00
2000
The discount amount in cents. 1000 = $10.00
2000
The ISO alpha-2 country code where tax is collected.
"US"
The sale tax amount in cents. 1000 = $10.00
2000
The amount that has been refunded in cents. 1000 = $10.00
2000
The order associated with the transaction.
The subscription associated with the transaction.
The customer associated with the transaction.
The description of the transaction.
Start period for the invoice as timestamp
End period for the invoice as timestamp
Pagination details for the list
Show child attributes
Show child attributes
Total number of records in the list
0
Total number of pages available
0
The current page number
1
The next page number, or null if there is no next page
2
The previous page number, or null if there is no previous page
null