Skip to main content

Client account

Client accounts are designed for clients working with multi-tenancy applications.

Client accounts are created programmatically. The API key (created in live or test mode) determines whether the Client account is a live or test account.

Create a Client Account for each of your customers to segregate their API operations.

Use the special Lune-Account header to perform operations against a specific Client Account.

  • Endpoints
    • GET
     /accounts/client/me
    POST
     /accounts/client
    GET
     /accounts/client
    PUT
     /accounts/client/{id}
    PATCH
     /accounts/client/{id}
    POST
     /accounts/client/{id}/logo
    The Client account object
    idstringrequired

    The Account's unique identifier

    namestringrequired

    The Account's name

    organisation_idstringrequired

    The unique identifier of the organisation this account belongs to

    handlestring^[a-z0-9-_]+$required

    handle is a client defined URL-friendly string that identifies the account.

    The handle is unique per organisation and account type.

    currencyenumrequired

    The account's currency.

    ISO 4217 3 character currency code.

    Note: Lune does not support all currency codes.

    Enum:
    • GBP
    • EUR
    • USD
    • SEK
    • CHF
    • PLN
    • DKK
    • NOK
    • BGN
    • INR
    • SGD
    • AED
    • AUD
    • HUF
    • ISK
    • CZK
    • CAD
    typeenumrequired

    The account's type.

    Enum:
    • live
    • test
    logostringrequired

    The account logo

    beneficiarystringrequired

    Retirement beneficiary

    This is the name that appears on future retirements that are made in this account. If none is present, the organisation beneficiary will be used instead.

    bundle_portfolio_idstringrequired

    Bundle portfolio id tied to the account.

    external_pages_visibilityenumrequired

    Enum to control the visibility of external pages such as sustainability and analytics pages.

    Enum:
    • public
    • hidden
  • ClientAccount
    • {
  "id": "ljmkOq7vXd239gAE9WALWQ8ZGVD5ExNz",
  "name": "ACME",
  "beneficiary": "ACME Inc",
  "currency": "USD",
  "type": "live",
  "organisation_id": "VndoQ0PZjGMzvYOZGwqy6kbgN1eOJx9B",
  "logo": null,
  "bundle_portfolio_id": null
}