@nevermined-io/payments
    Preparing search index...

    Interface PaymentOptions

    interface PaymentOptions {
        appId?: string;
        environment?: EnvironmentName;
        nvmApiKey: string;
        organizationId?: string;
        returnUrl?: string;
        scheme?: "nvm";
        version?: string;
    }
    Index

    Properties

    appId? environment? nvmApiKey organizationId? returnUrl? scheme? version?

    Properties

    appId?: string

    The app id. This attribute is optional and helps to associate assets registered into Nevermined with a common identifier.

    environment?: EnvironmentName

    The Nevermined environment to connect to.

    The environment is now derived from the NVM API key prefix (<prefix>:<jwt>), so this option is no longer required. It is still accepted for backward compatibility and as a fallback when the key prefix is unrecognized (e.g. local/custom development), but when the prefix maps to a known environment the key wins and this option is ignored (a one-time deprecation warning is emitted). It will be removed in a future release.

    nvmApiKey: string

    The Nevermined API Key. This key identify your user and is required to interact with the Nevermined API. You can get your API key by logging in to the Nevermined App.

    https://nevermined.ai/docs/tutorials/integration/nvm-api-keys

    organizationId?: string

    Optional organization ID to use as the active workspace for every authenticated backend request. When set, the SDK sends an X-Current-Org-Id header so the backend scopes published agents, plans, and other resources to this organization.

    If omitted the backend falls back to the API key's org tag or to the caller's most-recent active membership (see CurrentOrgContextGuard in nvm-monorepo).

    Override per-call via the organizationId option on create methods.

    Payments.setOrganizationId

    returnUrl?: string

    The URL to return to the app after a successful login.

    scheme?: "nvm"

    The payment scheme to use. Defaults to 'nvm'.

    version?: string

    Pins the Nevermined backend API version (MAJOR.MINOR) sent with every request via the Nevermined-Version header. Defaults to LOCKED_API_VERSION — the backend contract this SDK release is built and tested against. Override only to deliberately target a different backend contract.

    https://docs.nevermined.app/api-reference/versioning

    Settings

    Member Visibility

    On This Page

    Properties