Hilt Account API

The account API from Hilt — 7 operation(s) for account.

Operations 8

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /v1/account/me Get my full merchant profile · Get Me #
Ask an LLM
“Where can I load everything about my signed-in Hilt profile at once?”
“What profile data does the dashboard pull when I first log in?”
Tell an agent
Fetch my full account profile.
Show me the profile the dashboard bootstraps from.
PATCH /v1/account/me Update my profile settings · Update Me #
Ask an LLM
“Can I change my display name or timezone on my merchant profile?”
“How do I adjust my notification preferences?”
Tell an agent
Change my display name to {display_name}.
Set my profile timezone to {timezone}.
GET /v1/account/summary Get my merchant dashboard summary · Get Account Summary #
Ask an LLM
“What are my totals so far, split by USDC and SOL?”
“Is there an overview of my sales grouped per asset for the sidebar?”
Tell an agent
Show my merchant account summary by asset.
Give me the dashboard overview totals.
GET /v1/account/analytics View account analytics over a date range · Get Account Analytics #
Ask an LLM
“Can I see my account analytics between two dates?”
“How has my revenue trended day by day over the last month?”
Tell an agent
Show my account analytics from {start_date} to {end_date}.
Chart my daily account activity for the past {daily_days} days.
PATCH /v1/account/me/security Change my sign-in email or password · Update Account Security #
Ask an LLM
“How do I change the password I use to sign in to hilt.so?”
“Can I switch the email address on my merchant login?”
Tell an agent
Change my sign-in email to {email}.
Change my password from {current_password} to {new_password}.
GET /v1/account/delivery/readiness Check delivery setup readiness · Get Delivery Readiness #
Ask an LLM
“Is my account ready to deliver access to buyers after they pay?”
“Which delivery integrations still need configuring on my account?”
Tell an agent
Check whether my delivery setup is ready.
Show my delivery readiness status.
POST /v1/account/delivery/test Run a delivery test for a provider · Run Delivery Test #
Ask an LLM
“Can I test that access delivery works before a real customer buys?”
“How do I run a test delivery through a specific provider?”
Tell an agent
Run a delivery test through {provider}.
Send a test delivery using the {provider} integration.
DELETE /v1/account/account Delete my merchant account · Delete Account #
Ask an LLM
“How do I close and delete my Hilt account?”
“Is my data hard-deleted when I delete my account, or pseudonymised?”
Tell an agent destructive · confirm first
Delete my merchant account.
Close my account and pseudonymise my data.

Documentation

Specifications

Other Resources

🔗
OAuthScopes
https://raw.githubusercontent.com/api-evangelist/hilt-so/refs/heads/main/scopes/hilt-so-scopes.yml
🔗
Conventions
https://raw.githubusercontent.com/api-evangelist/hilt-so/refs/heads/main/conventions/hilt-so-conventions.yml
🔗
Idempotency
https://raw.githubusercontent.com/api-evangelist/hilt-so/refs/heads/main/conventions/hilt-so-conventions.yml
🔗
ErrorCatalog
https://raw.githubusercontent.com/api-evangelist/hilt-so/refs/heads/main/errors/hilt-so-problem-types.yml
🔗
Conformance
https://raw.githubusercontent.com/api-evangelist/hilt-so/refs/heads/main/conformance/hilt-so-conformance.yml
🔗
Lifecycle
https://raw.githubusercontent.com/api-evangelist/hilt-so/refs/heads/main/lifecycle/hilt-so-lifecycle.yml
🔗
Sandbox
https://raw.githubusercontent.com/api-evangelist/hilt-so/refs/heads/main/sandbox/hilt-so-sandbox.yml
🔗
DataModel
https://raw.githubusercontent.com/api-evangelist/hilt-so/refs/heads/main/data-model/hilt-so-data-model.yml
🔗
Webhooks
https://raw.githubusercontent.com/api-evangelist/hilt-so/refs/heads/main/asyncapi/hilt-so-webhooks-asyncapi.yml
🔗
Webhooks
https://docs.hilt.so/developers/webhooks
🔗
Plans
https://raw.githubusercontent.com/api-evangelist/hilt-so/refs/heads/main/plans/hilt-so-plans-pricing.yml
🔗
ChangeLog
https://raw.githubusercontent.com/api-evangelist/hilt-so/refs/heads/main/changelog/hilt-so-changelog.yml
🔗
Postman
https://www.hilt.so/downloads/hilt-postman-collection-latest.json
🔗
Postman
https://raw.githubusercontent.com/api-evangelist/hilt-so/refs/heads/main/postman/hilt-so-postman-collection.json
🔗
Packages
https://raw.githubusercontent.com/api-evangelist/hilt-so/refs/heads/main/packages/hilt-so-packages.yml
🔗
SDKs
https://raw.githubusercontent.com/api-evangelist/hilt-so/refs/heads/main/packages/hilt-so-packages.yml
🔗
CLI
https://raw.githubusercontent.com/api-evangelist/hilt-so/refs/heads/main/cli/hilt-so-cli.yml
🔗
Components
https://raw.githubusercontent.com/api-evangelist/hilt-so/refs/heads/main/components/hilt-so-components.yml
🔗
ToolCrosswalk
https://raw.githubusercontent.com/api-evangelist/hilt-so/refs/heads/main/mcp/hilt-so-tool-crosswalk.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/hilt-so:hilt-so-account-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

hilt-so-account-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Hilt Account API
  description: Hilt Pay Workspace and Hilt Pay API routes for zero-custody Solana checkout, MPP metered payment channels, receipts, memberships, entitlements, native subscriptions, webhooks, and support context.
  version: 1.0.0
  contact:
    name: Hilt
    url: https://www.hilt.so
    email: hello@hilt.so
  x-guidance: Start with POST /v1/access/agent-bootstrap. An agent can purchase 30 days of Starter, Growth, or Scale through the matching x402 V2 activation endpoint paid in Solana USDC. For metered integrations, settle PAYMENT-SIGNATURE through POST /v1/access/x402/settle and atomically consume through POST /v1/access/entitlements/consume before serving. Never send private keys, seed phrases, or wallet secrets.
servers:
- url: https://api.hilt.so
tags:
- name: Account
paths:
  /v1/account/me:
    get:
      tags:
      - Account
      summary: Get Me
      description: 'Returns the authenticated user''s full profile for dashboard bootstrap.

        This is the primary endpoint for dashboard bootstrap.'
      operationId: get_me_v1_account_me_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccountResponse'
    patch:
      tags:
      - Account
      summary: Update Me
      description: Updates mutable fields on the user profile.
      operationId: update_me_v1_account_me_patch
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AccountUpdateRequest'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdatedFieldsResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /v1/account/summary:
    get:
      tags:
      - Account
      summary: Get Account Summary
      description: 'Returns the merchant-facing dashboard summary used by the sidebar and overview.

        Figures are grouped by asset so we do not collapse USDC and SOL into one fake number.'
      operationId: get_account_summary_v1_account_summary_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccountSummaryResponse'
  /v1/account/analytics:
    get:
      tags:
      - Account
      summary: Get Account Analytics
      operationId: get_account_analytics_v1_account_analytics_get
      parameters:
      - name: window_days
        in: query
        required: false
        schema:
          type: integer
          maximum: 90
          minimum: 3
          default: 30
          title: Window Days
      - name: daily_days
        in: query
        required: false
        schema:
          type: integer
          maximum: 30
          minimum: 3
          default: 14
          title: Daily Days
      - name: start_date
        in: query
        required: false
        schema:
          anyOf:
          - type: string
            format: date
          - type: 'null'
          title: Start Date
      - name: end_date
        in: query
        required: false
        schema:
          anyOf:
          - type: string
            format: date
          - type: 'null'
          title: End Date
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WorkspaceAnalyticsResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /v1/account/me/security:
    patch:
      tags:
      - Account
      summary: Update Account Security
      description: Updates merchant email and password details for hilt.so sign-in.
      operationId: update_account_security_v1_account_me_security_patch
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AccountSecurityUpdateRequest'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdatedFieldsResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /v1/account/delivery/readiness:
    get:
      tags:
      - Account
      summary: Get Delivery Readiness
      operationId: get_delivery_readiness_v1_account_delivery_readiness_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeliveryReadinessResponse'
  /v1/account/delivery/test:
    post:
      tags:
      - Account
      summary: Run Delivery Test
      operationId: run_delivery_test_v1_account_delivery_test_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DeliveryTestRequest'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeliveryTestResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /v1/account/account:
    delete:
      tags:
      - Account
      summary: Delete Account
      description: 'Soft-deletes the account. Sets deleted_at timestamp and status = ''deleted''.

        GDPR-compliant: user data is pseudonymised, not hard-deleted.'
      operationId: delete_account_v1_account_account_delete
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DetailResponse'
components:
  schemas:
    AccountSecurityUpdateRequest:
      properties:
        email:
          anyOf:
          - type: string
            format: email
          - type: 'null'
          title: Email
        current_password:
          anyOf:
          - type: string
          - type: 'null'
          title: Current Password
        new_password:
          anyOf:
          - type: string
          - type: 'null'
          title: New Password
      type: object
      title: AccountSecurityUpdateRequest
    AccountAssetSummary:
      properties:
        token_mint:
          anyOf:
          - type: string
          - type: 'null'
          title: Token Mint
        asset_symbol:
          type: string
          title: Asset Symbol
        asset_decimals:
          type: integer
          title: Asset Decimals
        confirmed_payments:
          type: integer
          title: Confirmed Payments
        gross_minor_units:
          type: integer
          title: Gross Minor Units
        net_minor_units:
          type: integer
          title: Net Minor Units
        fee_minor_units:
          type: integer
          title: Fee Minor Units
      type: object
      required:
      - token_mint
      - asset_symbol
      - asset_decimals
      - confirmed_payments
      - gross_minor_units
      - net_minor_units
      - fee_minor_units
      title: AccountAssetSummary
    AccountUpdateRequest:
      properties:
        display_name:
          anyOf:
          - type: string
          - type: 'null'
          title: Display Name
        timezone:
          anyOf:
          - type: string
          - type: 'null'
          title: Timezone
        notification_prefs:
          anyOf:
          - type: object
          - type: 'null'
          title: Notification Prefs
        merchant_settings:
          anyOf:
          - type: object
          - type: 'null'
          title: Merchant Settings
      type: object
      title: AccountUpdateRequest
    DeliveryReadinessDefaults:
      properties:
        payout_wallet_configured:
          type: boolean
          title: Payout Wallet Configured
        default_redirect_url_configured:
          type: boolean
          title: Default Redirect Url Configured
        default_support_url_configured:
          type: boolean
          title: Default Support Url Configured
      additionalProperties: true
      type: object
      required:
      - payout_wallet_configured
      - default_redirect_url_configured
      - default_support_url_configured
      title: DeliveryReadinessDefaults
    AccountClaims:
      properties:
        hilt_score:
          type: boolean
          title: Hilt Score
        hilt_pay:
          type: boolean
          title: Hilt Pay
        hilt_ops:
          type: boolean
          title: Hilt Ops
        merchant_analytics:
          type: boolean
          title: Merchant Analytics
        buy_notifications:
          type: boolean
          title: Buy Notifications
        receipt_exports:
          type: boolean
          title: Receipt Exports
        tax_exports:
          type: boolean
          title: Tax Exports
        custom_checkout_domains:
          type: boolean
          title: Custom Checkout Domains
        is_staff:
          type: boolean
          title: Is Staff
      type: object
      required:
      - hilt_score
      - hilt_pay
      - hilt_ops
      - merchant_analytics
      - buy_notifications
      - receipt_exports
      - tax_exports
      - custom_checkout_domains
      - is_staff
      title: AccountClaims
    DeliveryReadinessResponse:
      properties:
        merchant_name:
          anyOf:
          - type: string
          - type: 'null'
          title: Merchant Name
        overall_status:
          type: string
          title: Overall Status
        active_membership_templates:
          type: integer
          title: Active Membership Templates
        defaults:
          $ref: '#/components/schemas/DeliveryReadinessDefaults'
        platforms:
          additionalProperties:
            type: object
          type: object
          title: Platforms
        blockers:
          items:
            type: string
          type: array
          title: Blockers
        warnings:
          items:
            type: string
          type: array
          title: Warnings
        checked_at:
          type: string
          title: Checked At
      additionalProperties: true
      type: object
      required:
      - merchant_name
      - overall_status
      - active_membership_templates
      - defaults
      - platforms
      - blockers
      - warnings
      - checked_at
      title: DeliveryReadinessResponse
    UpdatedFieldsResponse:
      properties:
        detail:
          type: string
          title: Detail
        updated_fields:
          items:
            type: string
          type: array
          title: Updated Fields
      additionalProperties: true
      type: object
      required:
      - detail
      - updated_fields
      title: UpdatedFieldsResponse
    DetailResponse:
      properties:
        detail:
          type: string
          title: Detail
      additionalProperties: true
      type: object
      required:
      - detail
      title: DetailResponse
    AccountSummaryResponse:
      properties:
        active_templates:
          type: integer
          title: Active Templates
        paying_members:
          type: integer
          title: Paying Members
        renewals_due:
          type: integer
          title: Renewals Due
        open_support_threads:
          type: integer
          title: Open Support Threads
        receipts_issued:
          type: integer
          title: Receipts Issued
        total_confirmed_payments:
          type: integer
          title: Total Confirmed Payments
        confirmed_payments_today:
          type: integer
          title: Confirmed Payments Today
        overall_assets:
          items:
            $ref: '#/components/schemas/AccountAssetSummary'
          type: array
          title: Overall Assets
        today_assets:
          items:
            $ref: '#/components/schemas/AccountAssetSummary'
          type: array
          title: Today Assets
      type: object
      required:
      - active_templates
      - paying_members
      - renewals_due
      - open_support_threads
      - receipts_issued
      - total_confirmed_payments
      - confirmed_payments_today
      - overall_assets
      - today_assets
      title: AccountSummaryResponse
    DeliveryTestResponse:
      properties:
        provider:
          type: string
          title: Provider
        status:
          type: string
          title: Status
        summary:
          type: string
          title: Summary
        checks:
          items:
            type: object
          type: array
          title: Checks
        checked_at:
          type: string
          title: Checked At
      additionalProperties: true
      type: object
      required:
      - provider
      - status
      - summary
      - checks
      - checked_at
      title: DeliveryTestResponse
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
            - type: string
            - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
      - loc
      - msg
      - type
      title: ValidationError
    AccountResponse:
      properties:
        user_id:
          type: string
          title: User Id
        email:
          anyOf:
          - type: string
          - type: 'null'
          title: Email
        wallet_address:
          anyOf:
          - type: string
          - type: 'null'
          title: Wallet Address
        display_name:
          anyOf:
          - type: string
          - type: 'null'
          title: Display Name
        tier:
          type: string
          title: Tier
        status:
          type: string
          title: Status
        email_verified:
          type: boolean
          title: Email Verified
        timezone:
          type: string
          title: Timezone
        created_at:
          type: string
          title: Created At
        key_id:
          anyOf:
          - type: string
          - type: 'null'
          title: Key Id
        sandbox:
          type: boolean
          title: Sandbox
        notification_prefs:
          type: object
          title: Notification Prefs
        merchant_settings:
          type: object
          title: Merchant Settings
        claims:
          $ref: '#/components/schemas/AccountClaims'
        has_password:
          type: boolean
          title: Has Password
          default: false
        auth_providers:
          items:
            type: string
          type: array
          title: Auth Providers
      type: object
      required:
      - user_id
      - email
      - wallet_address
      - display_name
      - tier
      - status
      - email_verified
      - timezone
      - created_at
      - key_id
      - sandbox
      - notification_prefs
      - merchant_settings
      - claims
      title: AccountResponse
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    DeliveryTestRequest:
      properties:
        provider:
          type: string
          title: Provider
      type: object
      required:
      - provider
      title: DeliveryTestRequest
    WorkspaceAnalyticsResponse:
      properties:
        summary:
          type: object
          title: Summary
        window_assets:
          items:
            type: object
          type: array
          title: Window Assets
        funnel_daily:
          items:
            type: object
          type: array
          title: Funnel Daily
        revenue_trend_daily:
          items:
            type: object
          type: array
          title: Revenue Trend Daily
        source_rows:
          items:
            type: object
          type: array
          title: Source Rows
        product_reports:
          items:
            type: object
          type: array
          title: Product Reports
        attention_items:
          items:
            type: object
          type: array
          title: Attention Items
        expiring_memberships:
          items:
            type: object
          type: array
          title: Expiring Memberships
        range_start_date:
          type: string
          title: Range Start Date
        range_end_date:
          type: string
          title: Range End Date
        generated_at:
          type: string
          title: Generated At
      additionalProperties: true
      type: object
      required:
      - summary
      - window_assets
      - funnel_daily
      - revenue_trend_daily
      - source_rows
      - product_reports
      - attention_items
      - expiring_memberships
      - range_start_date
      - range_end_date
      - generated_at
      title: WorkspaceAnalyticsResponse
x-hilt-agent-commerce:
  offer: https://api.hilt.so/v1/agent-commerce/offer
  catalog: https://api.hilt.so/agent-catalog.json
  pricing: https://api.hilt.so/pricing
  x402: https://api.hilt.so/x402