Get an owner's billing

Who pays an owner's fees and whether a payment method is on file.

Authorization

X-Api-Key header

Send your partner key on every request. An owner key acts for its one owner; an integration token also needs the owner's id in the X-Owner-Id header.

Path parameters

ownerIdstringpathrequired

Response

200 · application/json

successbooleanrequired

dataobject

ownerIdstring

Pass as X-Owner-Id on owner-level calls.

externalIdstring

emailstring

companyNamestring

feePayerstring

Allowed values:ownerintegration

payerAccountIdstring

paymentMethodstring

Allowed values:cardbank

paymentMethodReadyboolean

paymentSetupUrlstring

Hosted Stripe page; present only while no payment method is on file.

inviteSentboolean

errorstringnullable

Status codes

200Billing state.

401Missing, unknown or revoked API key.

404The resource does not exist under this owner.

GET/api/partner/v1/owners/{ownerId}/billing

curl -X GET "https://owner.myeztoll.com/api/partner/v1/owners/value/billing" \
  -H "X-Api-Key: $AEGIS_API_KEY"

Base URL

Response

{
  "success": true,
  "data": {
    "ownerId": "5b8e2c1d-3f4a-4e6b-9c7d-8e9f0a1b2c3d",
    "externalId": "NJTP-9f2c41a8",
    "email": "maria.alvarez@example.com",
    "companyName": "string",
    "feePayer": "owner",
    "payerAccountId": "string",
    "paymentMethod": "card",
    "paymentMethodReady": true,
    "paymentSetupUrl": "string",
    "inviteSent": true
  },
  "error": null
}