User

The User object represents a customer in your Fungies store.

A User object represents a customer who has made a purchase or registered in your store. Users store identity information including contact details, billing address, and custom identifiers. Each user is automatically created when a customer completes a checkout, or can be created manually via the API.

Users are central to the Fungies platform - they link to Orders, Payments, Subscriptions, and inventory items. You can use the API to create, retrieve, update, and manage user accounts.

Endpoints

MethodEndpointDescription
GET/v0/users/listList and filter users
POST/v0/users/createCreate a new user
GET/v0/users/{userId}Retrieve a user
PATCH/v0/users/{userId}/updateUpdate user details
PATCH/v0/users/{userId}/archiveArchive a user
PATCH/v0/users/{userId}/unarchiveRestore an archived user
GET/v0/users/{userId}/inventoryGet user's inventory items

The User object

objectstring

Object type identifier. Always "user" for User objects.

idstringrequired

Unique identifier (UUID) for this user.

emailstring | null

The user's email address. Used for transactional emails and account identification.

usernamestring | null

Username of the user, if set. Can be used as an alternative identifier.

detailsobject | null

Billing and contact details for the user.

details properties
typestring | null

The type of customer account. Possible values: "individual", "company"

firstNamestring | null

Customer's first name.

lastNamestring | null

Customer's last name.

phoneNumberstring | null

Customer's phone number (without country dial code).

dialCodestring | null

International dial code for the phone number (e.g., "+1", "+44").

addressstring | null

Primary street address line.

addressLine2string | null

Secondary address line (apartment, suite, unit, etc.).

citystring | null

City or locality.

statestring | null

State, province, or region.

postalCodestring | null

Postal or ZIP code.

countryCodestring | null

Two-letter ISO 3166-1 alpha-2 country code (e.g., "US", "GB", "DE").

companyNamestring | null

Company or organization name. Typically set when type is "company".

taxIdstring | null

Tax identification type or label.

taxNumberstring | null

Tax identification number (VAT number, EIN, etc.).

internalIdstring | null

Your custom identifier for this user. Use this to link Fungies users to your own system's user records.

Example response

{
  "status": "success",
  "data": {
    "user": {
      "object": "user",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "email": "customer@example.com",
      "username": "johndoe",
      "details": {
        "type": "individual",
        "firstName": "John",
        "lastName": "Doe",
        "dialCode": "+1",
        "phoneNumber": "5551234567",
        "address": "123 Main Street",
        "addressLine2": "Apt 4B",
        "city": "New York",
        "state": "NY",
        "postalCode": "10001",
        "countryCode": "US",
        "companyName": null,
        "taxId": null,
        "taxNumber": null
      },
      "internalId": "usr_abc123"
    }
  }
}

Orders

View orders placed by users

Payments

Payment transactions by users

Subscriptions

User subscription relationships

Events

Webhook events for user activity

Last updated

Overview

Understand how Fungies API objects relate to each other.

Product

The Product object represents a sellable item in your Fungies store.