API documentation
Integrations
Analytics
Billable events
Companies
Custom properties
Customers
Customers > Credits
Customers > Payment methods
Integrations
Invoices
Invoices > Transactions
Invoicing entities
Organisations
Payments
Price configurations
Products
Quotes
Subscriptions
- GETGet subscriptions
- GETGet subscription
- GETGet subscription phases
- GETGet subscription phase
- POSTCreate subscription update
- POSTCreate subscription updates
- POSTCreate subscription
- PUTUpdate subscription
- POSTActivate subscription
- POSTCancel subscription
- POSTPause subscription
- POSTReactivate subscription
- POSTRefresh seat products
- POSTRefresh subscriptions
- POSTReinstate subscription
- POSTTransition subscription to next phase
Third-party apps
Wallets
Get credit transactions
Retrieve all credit transactions associated with a credit product for a specific customer.
curl --request GET \
--url https://api.hyperline.co/v1/customers/{id}/credits/{productId}/transactions \
--header 'Authorization: Bearer <token>'
{
"meta": {
"total": 1,
"taken": 1,
"skipped": 0
},
"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": 24000,
"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.
Query Parameters
0 <= x <= 100
x >= 0
Response
List of CreditTransaction.
Credit transaction ID.
"cdt_BPZ19obsBS2qyo"
ID of the product related to the transaction.
"itm_3kXODDF42QXtnL"
ID of the customer related to the transaction.
"cus_Typ0px2W0aiEtl"
ID of the payment method related to the transaction.
"pm_1xMpj5bwRqN7LM"
ID of the invoice related to the transaction.
"inv_1eTaiytfA0i2Va"
ID of the event related to the credit consumption.
Type of credit transaction.
topup
, usage
"topup"
Type of credit transaction.
app
, portal
, api
"api"
Monetary amount. Expressed in currency's smallest unit.
24000
Value of credits related to the transaction.
32
Credit balance after the transaction.
2000
Credit transaction creation date.
"2023-10-13T07:00:01.860Z"
Credit transaction last edition date.
"2023-10-13T07:00:01.860Z"
Was this page helpful?
curl --request GET \
--url https://api.hyperline.co/v1/customers/{id}/credits/{productId}/transactions \
--header 'Authorization: Bearer <token>'
{
"meta": {
"total": 1,
"taken": 1,
"skipped": 0
},
"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": 24000,
"credit_count": 32,
"balance_after": 2000,
"created_at": "2023-10-13T07:00:01.860Z",
"updated_at": "2023-10-13T07:00:01.860Z"
}
]
}