Class OrganizationsAPI

Hierarchy

BasePaymentsAPI
- OrganizationsAPI

Constructors

constructor

new OrganizationsAPI(options: PaymentOptions): OrganizationsAPI
Parameters
- options: PaymentOptions
Returns OrganizationsAPI
Inherited from BasePaymentsAPI.constructor
- Defined in src/api/base-payments.ts:69

Properties

`Protected`accountAddress

accountAddress: string

`Protected` `Optional`appId

appId?: string

`Protected`currentOrganizationId

currentOrganizationId: string | null

`Protected`environment

environment: EnvironmentInfo

`Protected`environmentName

environmentName: EnvironmentName

`Protected`heliconeApiKey

heliconeApiKey: string

isBrowserInstance

isBrowserInstance: boolean = true

`Protected`nvmApiKey

nvmApiKey: string

`Protected`returnUrl

returnUrl: string

`Protected`scheme

scheme: "nvm"

`Protected` `Optional`version

version?: string

Methods

connectStripeAccount

connectStripeAccount(
    userEmail: string,
    userCountryCode: string,
    returnUrl: string,
): Promise<StripeCheckoutResult>
Connect user with Stripe
Parameters
- userEmail: string
  The email of the user
- userCountryCode: string
  The country code of the user
- returnUrl: string
  The return URL after the Stripe connection is completed
Returns Promise<StripeCheckoutResult>
The Stripe checkout result including the stripe account link, stripe account id, user id, user country code, link created at and link expires at. The stripe account link is the link that the user needs to click to connect with Stripe.
- Defined in src/api/organizations-api/organizations-api.ts:189

createMember

createMember(
    userId: string,
    userEmail?: string,
    userRole?: OrganizationMemberRole,
): Promise<CreateUserResponse>
Create a new member in the organization
Parameters
- userId: string
  The unique external ID of the new member
- OptionaluserEmail: string
  The email of the new member
- OptionaluserRole: OrganizationMemberRole
  The role of the new member
Returns Promise<CreateUserResponse>
The created member
- Defined in src/api/organizations-api/organizations-api.ts:33

getAccountAddress

getAccountAddress(): string | undefined
It returns the account address associated with the NVM API Key used to initialize the Payments Library instance.

Returns string | undefined
The account address extracted from the NVM API Key
Inherited from BasePaymentsAPI.getAccountAddress
- Defined in src/api/base-payments.ts:125

`Protected`getBackendHTTPOptions

getBackendHTTPOptions(
    method: string,
    body?: any,
    extraHeaders?: Record<string, string>,
): any
Internal
Returns the HTTP options required to query the backend.
Parameters
- method: string
  HTTP method.
- Optionalbody: any
  Optional request body.
- OptionalextraHeaders: Record<string, string>
  Optional per-call header overrides. Use { 'X-Current-Org-Id': orgId } to target a specific workspace for one call without mutating the instance-level pin.
Returns any
HTTP options object.
Inherited from BasePaymentsAPI.getBackendHTTPOptions
- Defined in src/api/base-payments.ts:162

getEnvironmentName

getEnvironmentName(): EnvironmentName
Returns the environment name used to initialize the Payments instance.

Returns EnvironmentName
The environment name (e.g. 'sandbox', 'live')
Inherited from BasePaymentsAPI.getEnvironmentName
- Defined in src/api/base-payments.ts:117

getMembers

getMembers(
    role?: OrganizationMemberRole,
    isActive?: boolean,
    page?: number,
    offset?: number,
): Promise<OrganizationMembersResponse>
Parameters
- Optionalrole: OrganizationMemberRole
  The role of the members to get
- OptionalisActive: boolean
  The active status of the members to get
- page: number = 1
  The page of the members to get
- offset: number = 100
  The number of members to get per page
Returns Promise<OrganizationMembersResponse>
The list of members
- Defined in src/api/organizations-api/organizations-api.ts:66

getMyMemberships

getMyMemberships(): Promise<MyMembership[]>
Lists every organization the authenticated user is an active member of, with their role and the organization's tier.

Powers workspace pickers in third-party tools built on the SDK, and the "where will this publish?" UX when a user belongs to multiple orgs.

Returns Promise<MyMembership[]>
An array of MyMembership — empty when the user has no active memberships and operates as a personal account.
Example
```
const memberships = await payments.organizations.getMyMemberships()
for (const m of memberships) {
  console.log(`${m.orgName} — ${m.role}`)
}
```
- Defined in src/api/organizations-api/organizations-api.ts:112

getOrganizationActivity

getOrganizationActivity(
orgId: string,
filters?: OrganizationActivityFilters,
): Promise<OrganizationActivityPage>
Lists events emitted into the activity feed of an organization the caller is an active member of (member invites, customer events, subscription transitions, webhook deliveries, …).

Requires the caller to be a Member or Admin of orgId; the backend returns 403 otherwise. Premium+ entitlement is enforced server-side.
Parameters
- orgId: string
  The organization id (e.g. org-…) whose feed to read.
- filters: OrganizationActivityFilters = {}
  Optional filter set — see OrganizationActivityFilters.
Returns Promise<OrganizationActivityPage>
A paginated OrganizationActivityPage.
Example
```
const page = await payments.organizations.getOrganizationActivity(orgId, {
  eventType: OrganizationActivityEventType.MemberInvited,
  page: 1,
  limit: 25,
})
```
- Defined in src/api/organizations-api/organizations-api.ts:145

getOrganizationId

getOrganizationId(): string | null
Returns the current organization context applied to every authenticated backend request via the X-Current-Org-Id header.

null means "no pinned workspace" — the backend falls back to the caller's API-key tag or most-recent active membership.

Returns string | null
Inherited from BasePaymentsAPI.getOrganizationId
- Defined in src/api/base-payments.ts:136

`Protected`getPublicHTTPOptions

getPublicHTTPOptions(
    method: string,
    body?: any,
): {
    body?: string;
    headers: { Accept: string; "Content-Type": string };
    method: string;
}
Internal
Get HTTP options for public backend requests (no authorization header). Converts body keys from snake_case to camelCase for consistency.
Parameters
- method: string
  HTTP method
- Optionalbody: any
  Optional request body (keys will be converted to camelCase)
Returns {
    body?: string;
    headers: { Accept: string; "Content-Type": string };
    method: string;
}
HTTP options object
Inherited from BasePaymentsAPI.getPublicHTTPOptions
- Defined in src/api/base-payments.ts:201

`Protected`parseNvmApiKey

parseNvmApiKey(): { accountAddress: string; heliconeApiKey: string }
Parses the NVM API Key to extract the account address.

Returns { accountAddress: string; heliconeApiKey: string }
Throws
PaymentsError if the API key is invalid.
Inherited from BasePaymentsAPI.parseNvmApiKey
- Defined in src/api/base-payments.ts:99

setOrganizationId

setOrganizationId(organizationId: string | null): void
Sets the organization context applied to every subsequent authenticated backend request via the X-Current-Org-Id header.

Pass null to clear the pin and fall back to the backend default.
Parameters
- organizationId: string | null
  Org ID (e.g. org-…) or null to clear.
Returns void
Inherited from BasePaymentsAPI.setOrganizationId
- Defined in src/api/base-payments.ts:148

`Static`getInstance

getInstance(options: PaymentOptions): OrganizationsAPI
Parameters
- options: PaymentOptions
Returns OrganizationsAPI
- Defined in src/api/organizations-api/organizations-api.ts:22

Class OrganizationsAPI

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns OrganizationsAPI

Properties

ProtectedaccountAddress

Protected OptionalappId

ProtectedcurrentOrganizationId

Protectedenvironment

ProtectedenvironmentName

ProtectedheliconeApiKey

isBrowserInstance

ProtectednvmApiKey

ProtectedreturnUrl

Protectedscheme

Protected Optionalversion

Methods

connectStripeAccount

Parameters

Returns Promise<StripeCheckoutResult>

createMember

Parameters

Returns Promise<CreateUserResponse>

getAccountAddress

Returns string | undefined

ProtectedgetBackendHTTPOptions

Parameters

Returns any

getEnvironmentName

Returns EnvironmentName

getMembers

Parameters

Returns Promise<OrganizationMembersResponse>

getMyMemberships

Returns Promise<MyMembership[]>

Example

getOrganizationActivity

Parameters

Returns Promise<OrganizationActivityPage>

Example

getOrganizationId

Returns string | null

ProtectedgetPublicHTTPOptions

Parameters

Returns { body?: string; headers: { Accept: string; "Content-Type": string }; method: string;}

ProtectedparseNvmApiKey

Returns { accountAddress: string; heliconeApiKey: string }

Throws

setOrganizationId

Parameters

Returns void

StaticgetInstance

Parameters

Returns OrganizationsAPI

Settings

On This Page

`Protected`accountAddress

`Protected` `Optional`appId

`Protected`currentOrganizationId

`Protected`environment

`Protected`environmentName

`Protected`heliconeApiKey

`Protected`nvmApiKey

`Protected`returnUrl

`Protected`scheme

`Protected` `Optional`version

`Protected`getBackendHTTPOptions

`Protected`getPublicHTTPOptions

Returns {
body?: string;
headers: { Accept: string; "Content-Type": string };
method: string;
}

`Protected`parseNvmApiKey

`Static`getInstance