Skip to main content
GET
Retrieve credit transactions

Authorizations

Authorization
string
header
required

See our authentication documentation for how to authorize your requests

Scopes

transactions

Read and write transactions

Headers

spacebring-network-id
string<uuid>

The id of the network. Required when using bearer token authentication

Query Parameters

companyRef
string<uuid>
deprecated

Deprecated. Use customerRef instead. The id of the company to get transactions for.

createDate[gte]
string

Get transactions with greater or equal createDate. Example: createDate[gte]=2021-05-21T10:00:00Z

createDate[lte]
string

Get transactions with less or equal createDate. Example: createDate[lte]=2021-05-21T10:00:00Z

customerRef
string<uuid>

UUID of the company or membership whose credits transactions to list.

limit
integer

Maximum number of transactions per page. Defaults to 25 when omitted or invalid; values above 100 are capped at 100.

Required range: 1 <= x <= 100
locationRef
string<uuid>

UUID of the location whose credits transactions to list.

membershipRef
string<uuid>
deprecated

Deprecated. Use customerRef instead. The id of the membership to get transactions for.

nextPageToken
string

Token to retrieve the next page of results.

status
string

Filter by payment status: 'succeeded' completed, 'pending' awaiting payment, 'processing' being settled by the gateway, 'failed' did not go through, 'canceled' called off before completion. Comma-separated, one or more of: canceled, failed, pending, processing, succeeded.

type
string

Filter by what moved the credits: allocations add credits ('adminAllocation' granted by an admin, 'subscriptionAllocation' from a plan, 'purchaseAllocation' from a bought package); 'booking', 'order', 'eventTicket' and 'adminCharge' spend them; 'refund' returns them; 'expiration' and 'subscriptionExpiration' remove unused credits. Matches analytics report type filters. Comma-separated, one or more of: adminAllocation, adminCharge, booking, eventTicket, expiration, order, purchaseAllocation, refund, subscriptionAllocation, subscriptionExpiration.

Response

OK

transactions
object[]
required

List of credits transactions.

nextPageToken
string

Pagination token to fetch the next page of results.

searchQueryNext
string

Ready-to-use query string with the current filters and nextPageToken to fetch the next page of results.