- Documentation
- API Reference
- Integrations
- Changelog
- Blog
- GETGet analytics
- GETGet companies
- GETGet custom properties
- POSTCreate custom property
- PUTUpdate custom property
- DELDelete custom property
- GETGet customers
- POSTCreate customer
- GETGet customer
- PUTUpdate customer
- DELDelete customer
- GETGet customer portal
- PUTArchive customer
- POSTBulk update providers/customers mapping
- GETList credit products
- POSTCreate credit product
- GETGet credit product
- GETList credit transactions
- POSTPurchase credits
- POSTTopup credits
- POSTCreate credits usage
- POSTCreate component token
- GETGet invoices
- POSTCreate one-off invoice
- POSTSends a draft invoice for payment
- GETGet invoice
- GETDownload invoice
- POSTCreate transaction
- GETGet invoicing entities
- POSTCreate invoicing entity
- GETGet invoicing entity
- PUTUpdate invoicing entity
- DELDelete invoicing entity
- POSTCreate payment
- POSTUpdate prices
- POSTRefresh subscriptions
- POSTCreate subscription update
- POSTCancel subscription
- POSTPause subscription
- POSTReactivate subscription
- GETGet subscriptions
- POSTCreate subscription
- GETGet subscription
- POSTRefresh seat products
Analytics
Companies
Custom properties
Customers
Customers > Credits
Integrations
Invoices
Invoicing entities
Payments
Price configurations
Subscriptions
List credit transactions
Retrieve all credit transactions associated with a credit product for a specific customer.
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
curl --request GET \
--url https://api.hyperline.co/v1/customers/{id}/credits/{productId}/transactions \
--header 'Authorization: Bearer <token>'
{
"meta": {
"total": 1,
"taken": 1,
"skipped": 123
},
"data": [
{
"id": "cdt_BPZ19obsBS2qyo",
"product_id": "itm_3kXODDF42QXtnL",
"price": {
"id": "pri_0Jv8EbMDOGsHcn",
"amount": 20000,
"pack_size": 120
},
"customer_id": "cus_Typ0px2W0aiEtl",
"payment_method_id": "pm_1xMpj5bwRqN7LM",
"invoice_id": "inv_1eTaiytfA0i2Va",
"event_id": "<string>",
"type": "topup",
"source": "api",
"amount_excluding_tax": 123,
"credit_count": 32,
"balance_after": 2000,
"created_at": "2023-10-13T07:00:01.860Z",
"updated_at": "2023-10-13T07:00:01.860Z"
}
]
}
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Path Parameters
Query Parameters
Response
Total of existing items.
Number of items returned.
Number of items skipped.
List of CreditTransaction.
Credit transaction ID.
ID of the product related to the transaction.
Price details related to the transaction.
Monetary amount in currency's smallest unit.
ID of the customer related to the transaction.
ID of the payment method related to the transaction.
ID of the invoice related to the transaction.
ID of the event related to the credit consumption.
Type of credit transaction.
topup
, usage
Type of credit transaction.
app
, portal
, api
Monetary amount in currency's smallest unit.
Value of credits related to the transaction.
Credit balance after the transaction.
Credit transaction creation date.
Credit transaction last edition date.
curl --request GET \
--url https://api.hyperline.co/v1/customers/{id}/credits/{productId}/transactions \
--header 'Authorization: Bearer <token>'
{
"meta": {
"total": 1,
"taken": 1,
"skipped": 123
},
"data": [
{
"id": "cdt_BPZ19obsBS2qyo",
"product_id": "itm_3kXODDF42QXtnL",
"price": {
"id": "pri_0Jv8EbMDOGsHcn",
"amount": 20000,
"pack_size": 120
},
"customer_id": "cus_Typ0px2W0aiEtl",
"payment_method_id": "pm_1xMpj5bwRqN7LM",
"invoice_id": "inv_1eTaiytfA0i2Va",
"event_id": "<string>",
"type": "topup",
"source": "api",
"amount_excluding_tax": 123,
"credit_count": 32,
"balance_after": 2000,
"created_at": "2023-10-13T07:00:01.860Z",
"updated_at": "2023-10-13T07:00:01.860Z"
}
]
}