Skip to main content
GET
Get Credit Grant

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

creditGrantId
string<uuid>
required

Query Parameters

fields
string

Comma-separated list of fields to include in the response. Supports dot notation for nested projection (e.g. id,name,user.email,trips.route.id). Unknown fields are silently dropped.

Response

OK

Credit grant

creditGrantId
string<uuid>
required
companyCreditAccountId
string<uuid>
required
organizationId
string<uuid>
required
companyId
string<uuid>
required
customerId
string<uuid>
required
code
string
required
amount
integer
required
availableAmount
integer
required
reservedAmount
integer
required
usedAmount
integer
required
status
enum<string>
required
Available options:
ACTIVE,
SUSPENDED,
EXPIRED,
CONSUMED,
CANCELED
createdAt
string<date-time>
required
updatedAt
string<date-time>
required
grantedByUserId
string<uuid> | null
reason
string | null
createdBy
string<uuid> | null
updatedBy
string<uuid> | null
deletedBy
string<uuid> | null
startsAt
string<date-time> | null
expiresAt
string<date-time> | null
canceledAt
string<date-time> | null
consumedAt
string<date-time> | null
deletedAt
string<date-time> | null