Class AccountsResource

constructor

• new AccountsResource(): Stripe.V2.Core.AccountsResource

  Returns Stripe.V2.Core.AccountsResource

persons

personTokens

create

• create(
      params?: Stripe.V2.Core.AccountCreateParams,
      options?: RequestOptions,
  ): Promise<Response<Stripe.V2.Core.Account>>

  An Account is a representation of a company, individual or other entity that a user interacts with. Accounts contain identifying information about the entity, and configurations that store the features an account has access to. An account can be configured as any or all of the following configurations: Customer, Merchant and/or Recipient.

  Parameters

  • Optionalparams: Stripe.V2.Core.AccountCreateParams
  • Optionaloptions: RequestOptions

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

• create(options?: RequestOptions): Promise<Response<Stripe.V2.Core.Account>>

  An Account is a representation of a company, individual or other entity that a user interacts with. Accounts contain identifying information about the entity, and configurations that store the features an account has access to. An account can be configured as any or all of the following configurations: Customer, Merchant and/or Recipient.

  Parameters

  • Optionaloptions: RequestOptions

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

retrieve

• retrieve(
      id: string,
      params?: Stripe.V2.Core.AccountRetrieveParams,
      options?: RequestOptions,
  ): Promise<Response<Stripe.V2.Core.Account>>

  Retrieves the details of an Account.

  Parameters

  • id: string
  • Optionalparams: Stripe.V2.Core.AccountRetrieveParams
  • Optionaloptions: RequestOptions

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

• retrieve(
      id: string,
      options?: RequestOptions,
  ): Promise<Response<Stripe.V2.Core.Account>>

  Retrieves the details of an Account.

  Parameters

  • id: string
  • Optionaloptions: RequestOptions

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

update

• update(
      id: string,
      params?: Stripe.V2.Core.AccountUpdateParams,
      options?: RequestOptions,
  ): Promise<Response<Stripe.V2.Core.Account>>

  Updates the details of an Account.

  Parameters

  • id: string
  • Optionalparams: Stripe.V2.Core.AccountUpdateParams
  • Optionaloptions: RequestOptions

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

list

• list(
      params?: Stripe.V2.Core.AccountListParams,
      options?: RequestOptions,
  ): ApiListPromise<Stripe.V2.Core.Account>

  Returns a list of Accounts.

  Parameters

  • Optionalparams: Stripe.V2.Core.AccountListParams
  • Optionaloptions: RequestOptions

  Returns ApiListPromise<Stripe.V2.Core.Account>

• list(options?: RequestOptions): ApiListPromise<Stripe.V2.Core.Account>

  Returns a list of Accounts.

  Parameters

  • Optionaloptions: RequestOptions

  Returns ApiListPromise<Stripe.V2.Core.Account>

close

• close(
      id: string,
      params?: Stripe.V2.Core.AccountCloseParams,
      options?: RequestOptions,
  ): Promise<Response<Stripe.V2.Core.Account>>

  Removes access to the Account and its associated resources. Closed Accounts can no longer be operated on, but limited information can still be retrieved through the API in order to be able to track their history.

  Parameters

  • id: string
  • Optionalparams: Stripe.V2.Core.AccountCloseParams
  • Optionaloptions: RequestOptions

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

• close(
      id: string,
      options?: RequestOptions,
  ): Promise<Response<Stripe.V2.Core.Account>>

  Removes access to the Account and its associated resources. Closed Accounts can no longer be operated on, but limited information can still be retrieved through the API in order to be able to track their history.

  Parameters

  • id: string
  • Optionaloptions: RequestOptions

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