Class RegistrationsResource

Index

Constructors

Methods

create retrieve update list

Constructors

constructor

new RegistrationsResource(): RegistrationsResource
Returns RegistrationsResource

Methods

create

create(
params: Stripe.Tax.RegistrationCreateParams,
options?: RequestOptions,
): Promise<Response<Stripe.Tax.Registration>>
Creates a new Tax Registration object.
Parameters
- params: Stripe.Tax.RegistrationCreateParams
- Optionaloptions: RequestOptions
Returns Promise<Response<Stripe.Tax.Registration>>
- Defined in node_modules/stripe/types/Tax/RegistrationsResource.d.ts:2531

retrieve

retrieve(
    id: string,
    params?: RegistrationRetrieveParams,
    options?: RequestOptions,
): Promise<Response<Stripe.Tax.Registration>>
Returns a Tax Registration object.
Parameters
- id: string
- Optionalparams: RegistrationRetrieveParams
- Optionaloptions: RequestOptions
Returns Promise<Response<Stripe.Tax.Registration>>
- Defined in node_modules/stripe/types/Tax/RegistrationsResource.d.ts:2539
retrieve(
id: string,
options?: RequestOptions,
): Promise<Response<Stripe.Tax.Registration>>
Returns a Tax Registration object.
Parameters
- id: string
- Optionaloptions: RequestOptions
Returns Promise<Response<Stripe.Tax.Registration>>
- Defined in node_modules/stripe/types/Tax/RegistrationsResource.d.ts:2544

update

update(
    id: string,
    params?: RegistrationUpdateParams,
    options?: RequestOptions,
): Promise<Response<Stripe.Tax.Registration>>
Updates an existing Tax Registration object.

A registration cannot be deleted after it has been created. If you wish to end a registration you may do so by setting expires_at.
Parameters
- id: string
- Optionalparams: RegistrationUpdateParams
- Optionaloptions: RequestOptions
Returns Promise<Response<Stripe.Tax.Registration>>
- Defined in node_modules/stripe/types/Tax/RegistrationsResource.d.ts:2554

list

list(
params?: Stripe.Tax.RegistrationListParams,
options?: RequestOptions,
): ApiListPromise<Stripe.Tax.Registration>
Returns a list of Tax Registration objects.
Parameters
- Optionalparams: Stripe.Tax.RegistrationListParams
- Optionaloptions: RequestOptions
Returns ApiListPromise<Stripe.Tax.Registration>
- Defined in node_modules/stripe/types/Tax/RegistrationsResource.d.ts:2563
list(options?: RequestOptions): ApiListPromise<Stripe.Tax.Registration>
Returns a list of Tax Registration objects.
Parameters
- Optionaloptions: RequestOptions
Returns ApiListPromise<Stripe.Tax.Registration>
- Defined in node_modules/stripe/types/Tax/RegistrationsResource.d.ts:2567