Class ConfigurationsResource

Index

Constructors

Methods

create retrieve update list

Constructors

constructor

new ConfigurationsResource(): Stripe.BillingPortal.ConfigurationsResource
Returns Stripe.BillingPortal.ConfigurationsResource

Methods

create

create(
params: Stripe.BillingPortal.ConfigurationCreateParams,
options?: RequestOptions,
): Promise<Response<Stripe.BillingPortal.Configuration>>
Creates a configuration that describes the functionality and behavior of a PortalSession
Parameters
- params: Stripe.BillingPortal.ConfigurationCreateParams
- Optionaloptions: RequestOptions
Returns Promise<Response<Stripe.BillingPortal.Configuration>>
- Defined in node_modules/stripe/types/BillingPortal/ConfigurationsResource.d.ts:639

retrieve

retrieve(
    id: string,
    params?: Stripe.BillingPortal.ConfigurationRetrieveParams,
    options?: RequestOptions,
): Promise<Response<Stripe.BillingPortal.Configuration>>
Retrieves a configuration that describes the functionality of the customer portal.
Parameters
- id: string
- Optionalparams: Stripe.BillingPortal.ConfigurationRetrieveParams
- Optionaloptions: RequestOptions
Returns Promise<Response<Stripe.BillingPortal.Configuration>>
- Defined in node_modules/stripe/types/BillingPortal/ConfigurationsResource.d.ts:647
retrieve(
id: string,
options?: RequestOptions,
): Promise<Response<Stripe.BillingPortal.Configuration>>
Retrieves a configuration that describes the functionality of the customer portal.
Parameters
- id: string
- Optionaloptions: RequestOptions
Returns Promise<Response<Stripe.BillingPortal.Configuration>>
- Defined in node_modules/stripe/types/BillingPortal/ConfigurationsResource.d.ts:652

update

update(
    id: string,
    params?: Stripe.BillingPortal.ConfigurationUpdateParams,
    options?: RequestOptions,
): Promise<Response<Stripe.BillingPortal.Configuration>>
Updates a configuration that describes the functionality of the customer portal.
Parameters
- id: string
- Optionalparams: Stripe.BillingPortal.ConfigurationUpdateParams
- Optionaloptions: RequestOptions
Returns Promise<Response<Stripe.BillingPortal.Configuration>>
- Defined in node_modules/stripe/types/BillingPortal/ConfigurationsResource.d.ts:660

list

list(
params?: Stripe.BillingPortal.ConfigurationListParams,
options?: RequestOptions,
): ApiListPromise<Stripe.BillingPortal.Configuration>
Returns a list of configurations that describe the functionality of the customer portal.
Parameters
- Optionalparams: Stripe.BillingPortal.ConfigurationListParams
- Optionaloptions: RequestOptions
Returns ApiListPromise<Stripe.BillingPortal.Configuration>
- Defined in node_modules/stripe/types/BillingPortal/ConfigurationsResource.d.ts:669
list(
options?: RequestOptions,
): ApiListPromise<Stripe.BillingPortal.Configuration>
Returns a list of configurations that describe the functionality of the customer portal.
Parameters
- Optionaloptions: RequestOptions
Returns ApiListPromise<Stripe.BillingPortal.Configuration>
- Defined in node_modules/stripe/types/BillingPortal/ConfigurationsResource.d.ts:673