Class PersonsResource

Index

Constructors

constructor

Methods

create retrieve update list del

Constructors

constructor

new PersonsResource(): PersonsResource
Returns PersonsResource

Methods

create

create(
    id: string,
    params?: Stripe.V2.Core.Accounts.PersonCreateParams,
    options?: RequestOptions,
): Promise<Response<Stripe.V2.Core.AccountPerson>>
Create a Person. Adds an individual to an Account's identity. You can set relationship attributes and identity information at creation.
Parameters
- id: string
- Optionalparams: Stripe.V2.Core.Accounts.PersonCreateParams
- Optionaloptions: RequestOptions
Returns Promise<Response<Stripe.V2.Core.AccountPerson>>
- Defined in node_modules/stripe/types/V2/Core/Accounts/PersonsResource.d.ts:1188
create(
id: string,
options?: RequestOptions,
): Promise<Response<Stripe.V2.Core.AccountPerson>>
Create a Person. Adds an individual to an Account's identity. You can set relationship attributes and identity information at creation.
Parameters
- id: string
- Optionaloptions: RequestOptions
Returns Promise<Response<Stripe.V2.Core.AccountPerson>>
- Defined in node_modules/stripe/types/V2/Core/Accounts/PersonsResource.d.ts:1193

retrieve

retrieve(
    accountId: string,
    id: string,
    params?: PersonRetrieveParams,
    options?: RequestOptions,
): Promise<Response<Stripe.V2.Core.AccountPerson>>
Retrieves a Person associated with an Account.
Parameters
- accountId: string
- id: string
- Optionalparams: PersonRetrieveParams
- Optionaloptions: RequestOptions
Returns Promise<Response<Stripe.V2.Core.AccountPerson>>
- Defined in node_modules/stripe/types/V2/Core/Accounts/PersonsResource.d.ts:1201
retrieve(
    accountId: string,
    id: string,
    options?: RequestOptions,
): Promise<Response<Stripe.V2.Core.AccountPerson>>
Retrieves a Person associated with an Account.
Parameters
- accountId: string
- id: string
- Optionaloptions: RequestOptions
Returns Promise<Response<Stripe.V2.Core.AccountPerson>>
- Defined in node_modules/stripe/types/V2/Core/Accounts/PersonsResource.d.ts:1207

update

update(
    accountId: string,
    id: string,
    params?: Stripe.V2.Core.Accounts.PersonUpdateParams,
    options?: RequestOptions,
): Promise<Response<Stripe.V2.Core.AccountPerson>>
Updates a Person associated with an Account.
Parameters
- accountId: string
- id: string
- Optionalparams: Stripe.V2.Core.Accounts.PersonUpdateParams
- Optionaloptions: RequestOptions
Returns Promise<Response<Stripe.V2.Core.AccountPerson>>
- Defined in node_modules/stripe/types/V2/Core/Accounts/PersonsResource.d.ts:1216

list

list(
    id: string,
    params?: PersonListParams,
    options?: RequestOptions,
): ApiListPromise<Stripe.V2.Core.AccountPerson>
Returns a paginated list of Persons associated with an Account.
Parameters
- id: string
- Optionalparams: PersonListParams
- Optionaloptions: RequestOptions
Returns ApiListPromise<Stripe.V2.Core.AccountPerson>
- Defined in node_modules/stripe/types/V2/Core/Accounts/PersonsResource.d.ts:1226
list(
id: string,
options?: RequestOptions,
): ApiListPromise<Stripe.V2.Core.AccountPerson>
Returns a paginated list of Persons associated with an Account.
Parameters
- id: string
- Optionaloptions: RequestOptions
Returns ApiListPromise<Stripe.V2.Core.AccountPerson>
- Defined in node_modules/stripe/types/V2/Core/Accounts/PersonsResource.d.ts:1231

del

del(
    accountId: string,
    id: string,
    params?: PersonDeleteParams,
    options?: RequestOptions,
): Promise<Response<DeletedObject>>
Delete a Person associated with an Account.
Parameters
- accountId: string
- id: string
- Optionalparams: PersonDeleteParams
- Optionaloptions: RequestOptions
Returns Promise<Response<DeletedObject>>
- Defined in node_modules/stripe/types/V2/Core/Accounts/PersonsResource.d.ts:1239
del(
    accountId: string,
    id: string,
    options?: RequestOptions,
): Promise<Response<DeletedObject>>
Delete a Person associated with an Account.
Parameters
- accountId: string
- id: string
- Optionaloptions: RequestOptions
Returns Promise<Response<DeletedObject>>
- Defined in node_modules/stripe/types/V2/Core/Accounts/PersonsResource.d.ts:1245

Class PersonsResource

Index

Constructors

Methods

Constructors

constructor

Returns PersonsResource

Methods

create

Parameters

Returns Promise<Response<Stripe.V2.Core.AccountPerson>>

Parameters

Returns Promise<Response<Stripe.V2.Core.AccountPerson>>

retrieve

Parameters

Returns Promise<Response<Stripe.V2.Core.AccountPerson>>

Parameters

Returns Promise<Response<Stripe.V2.Core.AccountPerson>>

update

Parameters

Returns Promise<Response<Stripe.V2.Core.AccountPerson>>

list

Parameters

Returns ApiListPromise<Stripe.V2.Core.AccountPerson>

Parameters

Returns ApiListPromise<Stripe.V2.Core.AccountPerson>

del

Parameters

Returns Promise<Response<DeletedObject>>

Parameters

Returns Promise<Response<DeletedObject>>

Settings

On This Page