Create a customer

POST

customers

Create a customer

curl --request POST \
  --url https://api.alguna.io/customers \
  --header 'Alguna-Version: <alguna-version>' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "currency": "USD",
  "name": "Acme Corp",
  "aliases": [
    "<string>"
  ],
  "autopay_timing": "on_due_date",
  "billing_address": {
    "city": "San Francisco",
    "country": "USA",
    "line1": "123 Main St",
    "postal_code": "94105",
    "state": "CA",
    "line2": "Suite 100"
  },
  "contacts": [
    {
      "email": "john@example.com",
      "is_primary": true,
      "email_preferences": [
        "<string>"
      ],
      "first_name": "John",
      "id": "<string>",
      "last_name": "Doe"
    }
  ]
}
'

import requests

url = "https://api.alguna.io/customers"

payload = {
    "currency": "USD",
    "name": "Acme Corp",
    "aliases": ["<string>"],
    "autopay_timing": "on_due_date",
    "billing_address": {
        "city": "San Francisco",
        "country": "USA",
        "line1": "123 Main St",
        "postal_code": "94105",
        "state": "CA",
        "line2": "Suite 100"
    },
    "contacts": [
        {
            "email": "john@example.com",
            "is_primary": True,
            "email_preferences": ["<string>"],
            "first_name": "John",
            "id": "<string>",
            "last_name": "Doe"
        }
    ]
}
headers = {
    "Alguna-Version": "<alguna-version>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'Alguna-Version': '<alguna-version>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    currency: 'USD',
    name: 'Acme Corp',
    aliases: ['<string>'],
    autopay_timing: 'on_due_date',
    billing_address: {
      city: 'San Francisco',
      country: 'USA',
      line1: '123 Main St',
      postal_code: '94105',
      state: 'CA',
      line2: 'Suite 100'
    },
    contacts: [
      {
        email: 'john@example.com',
        is_primary: true,
        email_preferences: ['<string>'],
        first_name: 'John',
        id: '<string>',
        last_name: 'Doe'
      }
    ]
  })
};

fetch('https://api.alguna.io/customers', 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>"
}

{
  "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

Idempotency-Key

string

A unique string that makes a retried write safe. If you send the same request with the same key within 24 hours, the API returns the stored response and does not run the request again. A 5xx or 429 response is not stored, so a retry with that key runs the request again.

Maximum string length: 255

Example:

"ik_a1b2c3d4e5f6"

Body

application/json

currency

string

required

ISO 4217 currency code

Example:

"USD"

name

string

required

The name of the customer

Example:

"Acme Corp"

aliases

string[] | null

Alternative identifiers for the customer

autopay_timing

enum<string> | null

When auto-pay charges the customer's invoices. on_issue: when the invoice is issued. on_due_date: on the invoice's due date. Defaults to the organization's default Autopay Timing.

Available options:

on_issue,

on_due_date

Example:

"on_due_date"

billing_address

object | null

Customer billing address

Show child attributes

contacts

object[]

Customer contacts

Show child attributes

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

Create a customer

curl --request POST \
  --url https://api.alguna.io/customers \
  --header 'Alguna-Version: <alguna-version>' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "currency": "USD",
  "name": "Acme Corp",
  "aliases": [
    "<string>"
  ],
  "autopay_timing": "on_due_date",
  "billing_address": {
    "city": "San Francisco",
    "country": "USA",
    "line1": "123 Main St",
    "postal_code": "94105",
    "state": "CA",
    "line2": "Suite 100"
  },
  "contacts": [
    {
      "email": "john@example.com",
      "is_primary": true,
      "email_preferences": [
        "<string>"
      ],
      "first_name": "John",
      "id": "<string>",
      "last_name": "Doe"
    }
  ]
}
'

import requests

url = "https://api.alguna.io/customers"

payload = {
    "currency": "USD",
    "name": "Acme Corp",
    "aliases": ["<string>"],
    "autopay_timing": "on_due_date",
    "billing_address": {
        "city": "San Francisco",
        "country": "USA",
        "line1": "123 Main St",
        "postal_code": "94105",
        "state": "CA",
        "line2": "Suite 100"
    },
    "contacts": [
        {
            "email": "john@example.com",
            "is_primary": True,
            "email_preferences": ["<string>"],
            "first_name": "John",
            "id": "<string>",
            "last_name": "Doe"
        }
    ]
}
headers = {
    "Alguna-Version": "<alguna-version>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'Alguna-Version': '<alguna-version>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    currency: 'USD',
    name: 'Acme Corp',
    aliases: ['<string>'],
    autopay_timing: 'on_due_date',
    billing_address: {
      city: 'San Francisco',
      country: 'USA',
      line1: '123 Main St',
      postal_code: '94105',
      state: 'CA',
      line2: 'Suite 100'
    },
    contacts: [
      {
        email: 'john@example.com',
        is_primary: true,
        email_preferences: ['<string>'],
        first_name: 'John',
        id: '<string>',
        last_name: 'Doe'
      }
    ]
  })
};

fetch('https://api.alguna.io/customers', 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>"
}

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

API Reference

Examples

SDKs

API Reference

Webhooks

Authorizations

Headers

Body

Response