Lookup Customer by Alias

GET

account-lookup

curl --request GET \
  --url 'https://api.alguna.io/account-lookup?alias=QBO-12345' \
  --header 'Authorization: Bearer YOUR_API_KEY'

{
  "accountId": "acc_abc123def456"
}

{
  "code": "not_found",
  "message": "no account found for alias: QBO-12345"
}

Look up a customer’s account ID using an alias. This is useful when you have an external identifier and need to find the corresponding Alguna customer.

Query Parameters

string

required

The alias to look up. This can be:

The account ID itself
A user-defined alias set on the customer

Response

string

The Alguna account ID corresponding to the provided alias.

Example

curl --request GET \
  --url 'https://api.alguna.io/account-lookup?alias=QBO-12345' \
  --header 'Authorization: Bearer YOUR_API_KEY'

{
  "accountId": "acc_abc123def456"
}

{
  "code": "not_found",
  "message": "no account found for alias: QBO-12345"
}

⌘I

curl --request GET \
  --url 'https://api.alguna.io/account-lookup?alias=QBO-12345' \
  --header 'Authorization: Bearer YOUR_API_KEY'

{
  "accountId": "acc_abc123def456"
}

{
  "code": "not_found",
  "message": "no account found for alias: QBO-12345"
}

API Reference

Billing Events & Usage Metering

Bundles

Credit Grants

Credit Notes

Customers

Invoices

Plans

Products

Refunds

Subscriptions

Subscription Versions

Wallets

Lookup Customer by Alias

Query Parameters

Response

Example

​Query Parameters

​Response

​Example

Query Parameters

Response

Example