LegalEntities
Defined in: src/team/client.gen.ts:286
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new LegalEntities(
_core):LegalEntities
Defined in: src/team/client.gen.ts:287
Parameters
Section titled “Parameters”Returns
Section titled “Returns”LegalEntities
Methods
Section titled “Methods”get(
id,options?):Promise<{billingAddress: {city?:string|null;country?:string|null;line1?:string|null;line2?:string|null;phone_number?:string|null;postal_code?:string|null;state?:string|null; };createdAt:string;displayName:string;id:string;isDefault?:boolean;status:"UNSUBMITTED"|"UNVERIFIED"|"IN_PROGRESS"|"VERIFIED"|"REJECTED"; }>
Defined in: src/team/client.gen.ts:296
Get legal entity
Get a legal entity by its ID.
GET /v2/legal_entities/{id} — requires OAuth scope: legal_entities, legal_entities.readonly
Parameters
Section titled “Parameters”string
options?
Section titled “options?”Returns
Section titled “Returns”Promise<{ billingAddress: { city?: string | null; country?: string | null; line1?: string | null; line2?: string | null; phone_number?: string | null; postal_code?: string | null; state?: string | null; }; createdAt: string; displayName: string; id: string; isDefault?: boolean; status: "UNSUBMITTED" | "UNVERIFIED" | "IN_PROGRESS" | "VERIFIED" | "REJECTED"; }>
list()
Section titled “list()”list(
query?,options?):PagePromise<{items:object[];next_cursor?:string|null; }>
Defined in: src/team/client.gen.ts:315
List legal entities
List legal entities for the account.
GET /v2/legal_entities — requires OAuth scope: legal_entities, legal_entities.readonly
Await for a single page, or for await to iterate items across all pages.
Parameters
Section titled “Parameters”query?
Section titled “query?”cursor?
Section titled “cursor?”string | null
limit?
Section titled “limit?”number | null
options?
Section titled “options?”Returns
Section titled “Returns”PagePromise<{ items: object[]; next_cursor?: string | null; }>