View billing profile

GET

/billing/configuration/:serviceGroup/:entityType/:entityId

GET

/api/billing/configuration/:serviceGroup/:entityType/:entityId

$ curl https://api-sandbox.payabli.com/api/billing/configuration/PayIn/Organization/123

1 {
2   "id": 1,
3   "versionId": 4229,
4   "versionNumber": 31,
5   "business": {
6     "entityType": 1,
7     "entityId": 123
8   },
9   "name": "Default PayIn Profile",
10   "feeType": 1,
11   "createdAt": "2026-01-01T00:00:00Z",
12   "updatedAt": "2026-01-01T00:00:00Z",
13   "parentId": "1:123",
14   "billableEvents": [
15     {
16       "id": 1,
17       "name": "payin-card-sale-all",
18       "vertical": 1,
19       "service": 1,
20       "serviceType": 0,
21       "eventType": 4,
22       "eventGroup": 5,
23       "eventSource": 0,
24       "regionType": 1,
25       "feeSchedules": [
26         {
27           "id": 13419,
28           "value": 0.3,
29           "rate": 2.9,
30           "passthrough": 0,
31           "payor": {
32             "entityType": 1,
33             "entityId": 123
34           },
35           "collector": {
36             "entityType": 1,
37             "entityId": 123
38           },
39           "overflowPayor": null,
40           "overflowCollectionSchedule": null,
41           "minimumTotal": null,
42           "maximumTotal": null,
43           "effectiveDate": "2026-01-01T00:00:00Z",
44           "expirationDate": null,
45           "createdAt": "2026-01-01T00:00:00Z",
46           "updatedAt": "2026-01-01T00:00:00Z",
47           "createdBy": "395",
48           "collectionSchedule": 2,
49           "billDate": 1,
50           "overrideFeeScheduleId": null,
51           "feeType": 1
52         }
53       ]
54     }
55   ]
56 }

Requires a token with the billing_profile_read permission and access to the requested entity; otherwise the call gets 403 Forbidden.

If the entity exists but has no profile assigned, the call returns 404 Not Found.

Returns the billing profile currently assigned to an entity, including its billable events and fee schedules. Use it to read the pricing terms in effect for an organization, paypoint, template, or application. Requires a token with the `billing_profile_read` permission and access to the requested entity; otherwise the call gets `403 Forbidden`. If the entity exists but has no profile assigned, the call returns `404 Not Found`.

Path parameters

serviceGroupenumRequired

The billing vertical. Only PayIn and PayOut are accepted; any other value returns 400 Bad Request.

Allowed values:

entityTypeenumRequired

The owning entity type: Organization, Paypoint, Template, or Application.

Allowed values:

entityIdlongRequired

The numeric identifier of the entity.

Response

The billing profile assigned to the entity.

idlong

Unique, server-generated profile identifier.

versionIdlong

Identifier of this specific version of the profile.

versionNumberinteger

Sequential version counter. Starts at 1 and increments on every edit (profiles are append-only versioned, not mutated in place).

businessobject

An owning or participating entity, as returned by the View profile endpoint (entityType serialized as an integer).

namestring

Descriptive name for the profile.

feeTypeenum

Pricing model, serialized as an integer by the View profile endpoint: 1 Flat, 2 ICP (interchange-plus).

createdAtdatetime

When this version was created.

updatedAtdatetime

When this version was last updated.

parentIdstring

Parent-entity reference used for inheritance and permission checks, formatted as {entityType}:{entityId} (for example, 1:2 is organization 2). Org-level profiles reference their own organization; paypoint-level profiles reference their parent organization.

billableEventslist of objects

The chargeable events this profile covers.

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

500

Internal Server Error