Get a customer

GET

customers

{id}

Get a customer

curl --request GET \
  --url https://api.alguna.io/customers/{id} \
  --header 'Alguna-Version: <alguna-version>' \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.alguna.io/customers/{id}"

headers = {
    "Alguna-Version": "<alguna-version>",
    "Authorization": "Bearer <token>"
}

response = requests.get(url, headers=headers)

print(response.text)

const options = {
  method: 'GET',
  headers: {'Alguna-Version': '<alguna-version>', Authorization: 'Bearer <token>'}
};

fetch('https://api.alguna.io/customers/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "assignments": [
    {
      "type": "sales",
      "user_id": "usr_abc123"
    }
  ],
  "autopay_timing": "on_issue",
  "created_at": "2026-04-01T10:00:00Z",
  "currency": "USD",
  "id": "cust_abc123",
  "name": "Acme Corp",
  "updated_at": "2026-04-01T12:30:00Z",
  "aliases": [
    "<string>"
  ],
  "billing_address": {
    "city": "San Francisco",
    "country": "USA",
    "line1": "123 Main St",
    "postal_code": "94105",
    "state": "CA",
    "line2": "Suite 100"
  },
  "contacts": [
    {
      "email": "john@example.com",
      "id": "cont_abc123",
      "is_primary": true,
      "email_preferences": [
        "<string>"
      ],
      "first_name": "John",
      "last_name": "Doe"
    }
  ],
  "tax_country": "DEU",
  "tax_id": "DE123456789",
  "tax_rate": "0.20",
  "tax_reason": "standard_rated",
  "tax_status": "taxable",
  "tax_type": "vat"
}

{
  "detail": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "<string>"
}

{
  "detail": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "<string>"
}

{
  "detail": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "<string>"
}

{
  "detail": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "<string>"
}

{
  "detail": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "<string>"
}

{
  "detail": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "<string>"
}

{
  "detail": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "<string>"
}

{
  "detail": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "<string>"
}

Authorizations

Authorization

string

header

required

API key authentication. Pass your API key as a Bearer token.

Headers

Alguna-Version

enum<string>

required

Available options:

2026-04-01

Path Parameters

string

required

Unique identifier for the customer

Response

Success

assignments

object[]

required

Users assigned to the customer, such as the account executive and customer success manager

Show child attributes

autopay_timing

enum<string>

required

When auto-pay charges the customer's invoices. on_issue: when the invoice is issued. on_due_date: on the invoice's due date. Subscriptions and invoices can override it.

Available options:

on_issue,

on_due_date

Example:

"on_issue"

created_at

string<date-time>

required

Timestamp when the customer was created

Example:

"2026-04-01T10:00:00Z"

currency

string

required

ISO 4217 currency code

Example:

"USD"

string

required

Unique identifier for the customer

Example:

"cust_abc123"

name

string

required

Customer name

Example:

"Acme Corp"

updated_at

string<date-time>

required

Timestamp when the customer was last updated

Example:

"2026-04-01T12:30:00Z"

aliases

string[]

Alternative identifiers for the customer

billing_address

object | null

Customer billing address

Show child attributes

contacts

object[]

Customer contacts

Show child attributes

tax_country

string | null

ISO 3166-1 alpha-3 country code used for tax determination

Example:

"DEU"

tax_id

string | null

Customer tax identification number

Example:

"DE123456789"

tax_rate

string | null

Tax rate applied to the customer, expressed as a decimal fraction (0.20 = 20%)

Example:

"0.20"

tax_reason

enum<string> | null

Reason determining how tax is applied to the customer

Available options:

standard_rated,

reverse_charge,

not_collecting,

customer_exempt,

zero_rated,

other

Example:

"standard_rated"

tax_status

string | null

Customer tax status

Example:

"taxable"

tax_type

enum<string> | null

Type of tax applied to the customer

Available options:

gst,

hst,

igst,

jct,

lease_tax,

pst,

qst,

sales_tax,

service_tax,

vat

Example:

"vat"

⌘I

Get a customer

curl --request GET \
  --url https://api.alguna.io/customers/{id} \
  --header 'Alguna-Version: <alguna-version>' \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.alguna.io/customers/{id}"

headers = {
    "Alguna-Version": "<alguna-version>",
    "Authorization": "Bearer <token>"
}

response = requests.get(url, headers=headers)

print(response.text)

const options = {
  method: 'GET',
  headers: {'Alguna-Version': '<alguna-version>', Authorization: 'Bearer <token>'}
};

fetch('https://api.alguna.io/customers/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "assignments": [
    {
      "type": "sales",
      "user_id": "usr_abc123"
    }
  ],
  "autopay_timing": "on_issue",
  "created_at": "2026-04-01T10:00:00Z",
  "currency": "USD",
  "id": "cust_abc123",
  "name": "Acme Corp",
  "updated_at": "2026-04-01T12:30:00Z",
  "aliases": [
    "<string>"
  ],
  "billing_address": {
    "city": "San Francisco",
    "country": "USA",
    "line1": "123 Main St",
    "postal_code": "94105",
    "state": "CA",
    "line2": "Suite 100"
  },
  "contacts": [
    {
      "email": "john@example.com",
      "id": "cont_abc123",
      "is_primary": true,
      "email_preferences": [
        "<string>"
      ],
      "first_name": "John",
      "last_name": "Doe"
    }
  ],
  "tax_country": "DEU",
  "tax_id": "DE123456789",
  "tax_rate": "0.20",
  "tax_reason": "standard_rated",
  "tax_status": "taxable",
  "tax_type": "vat"
}

{
  "detail": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "<string>"
}

{
  "detail": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "<string>"
}

{
  "detail": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "<string>"
}

{
  "detail": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "<string>"
}

{
  "detail": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "<string>"
}

{
  "detail": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "<string>"
}

{
  "detail": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "<string>"
}

{
  "detail": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "<string>"
}

API Reference

Examples

SDKs

API Reference

Webhooks

Authorizations

Headers

Path Parameters

Response