List billing profiles

View as MarkdownOpen in Claude

Returns every billing profile that belongs to an organization. This is the data behind the Profile Library table in the Payabli Portal.

Requires a token with the billing_profile_read permission; a token without it gets 403 Forbidden.

Path parameters

orgIdlongRequired
The organization's numeric identifier.

Query parameters

profileNamestringOptional
Filter to profiles whose name contains this string.
feeTypelist of enumsOptional

Filter by fee type. Repeatable to match more than one. Send the enum value (1 Flat, 2 ICP).

Allowed values:
serviceVerticallist of enumsOptional

Filter by billing vertical. Repeatable to match more than one. Send the enum value (1 PayIn, 2 PayOut, 3 PayOps).

Allowed values:
profileIdlongOptional
Filter to a single profile by its identifier.
limitRecordlongOptionalDefaults to 20

Page size. Defaults to 20. Passing 0 returns no records — use a positive value to page through results.

fromRecordlongOptionalDefaults to 0

Zero-based offset into the result set. Defaults to 0.

Response

A page of billing profiles.
summaryobject
Pagination summary for the profile list.
recordslist of objects
The billing profiles on this page. Empty when the org has no profiles.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
500
Internal Server Error