List credit products
- 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 products
List all credits products attached to a customer.
GET
/
v1
/
customers
/
{id}
/
credits
Authorization
string
*
Bearer
Authorization
Required
string
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
id
string
*
id
Required
string
curl --request GET \
--url https://api.hyperline.co/v1/customers/{id}/credits \
--header 'Authorization: Bearer <token>'
{
"meta": {
"total": 1,
"taken": 1,
"skipped": 123
},
"data": [
{
"product_id": "itm_3kXODDF42QXtnL",
"current_balance": 2000,
"customer_id": "cus_Typ0px2W0aiEtl",
"name": "Credit name",
"low_count_threshold": 10,
"last_refreshed_at": "2023-11-23T09:00:01.860Z",
"created_at": "2023-10-12T07:00:01.860Z",
"updated_at": "2023-10-13T10:00:01.860Z"
}
]
}
Authorizations
Authorization
string
headerrequiredBearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Path Parameters
id
string
requiredResponse
200 - application/json
meta
object
requiredmeta.total
number
requiredTotal of existing items.
meta.taken
number
requiredNumber of items returned.
meta.skipped
number
requiredNumber of items skipped.
data
object[]
requiredList of Credit.
data.product_id
string
requiredCredit product ID.
data.current_balance
number
requiredCurrent credit balance.
data.customer_id
string
requiredCustomer ID related to the credit
data.name
string
requiredCredit name
data.low_count_threshold
number | null
requiredValue indicating a low threshold.
data.last_refreshed_at
string
requiredCredit last refresh date.
data.created_at
string
requiredCredit creation date.
data.updated_at
string
requiredCredit last edition date.
curl --request GET \
--url https://api.hyperline.co/v1/customers/{id}/credits \
--header 'Authorization: Bearer <token>'
{
"meta": {
"total": 1,
"taken": 1,
"skipped": 123
},
"data": [
{
"product_id": "itm_3kXODDF42QXtnL",
"current_balance": 2000,
"customer_id": "cus_Typ0px2W0aiEtl",
"name": "Credit name",
"low_count_threshold": 10,
"last_refreshed_at": "2023-11-23T09:00:01.860Z",
"created_at": "2023-10-12T07:00:01.860Z",
"updated_at": "2023-10-13T10:00:01.860Z"
}
]
}