Class PlansResource

Index

Constructors

Methods

create retrieve update list del

Constructors

constructor

new PlansResource(): PlansResource
Returns PlansResource

Methods

create

create(
params: Stripe.PlanCreateParams,
options?: RequestOptions,
): Promise<Response<Stripe.Plan>>
You can now model subscriptions more flexibly using the Prices API. It replaces the Plans API and is backwards compatible to simplify your migration.
Parameters
- params: Stripe.PlanCreateParams
- Optionaloptions: RequestOptions
Returns Promise<Response<Stripe.Plan>>
- Defined in node_modules/stripe/types/PlansResource.d.ts:253

retrieve

retrieve(
    id: string,
    params?: PlanRetrieveParams,
    options?: RequestOptions,
): Promise<Response<Stripe.Plan>>
Retrieves the plan with the given ID.
Parameters
- id: string
- Optionalparams: PlanRetrieveParams
- Optionaloptions: RequestOptions
Returns Promise<Response<Stripe.Plan>>
- Defined in node_modules/stripe/types/PlansResource.d.ts:261
retrieve(id: string, options?: RequestOptions): Promise<Response<Stripe.Plan>>
Retrieves the plan with the given ID.
Parameters
- id: string
- Optionaloptions: RequestOptions
Returns Promise<Response<Stripe.Plan>>
- Defined in node_modules/stripe/types/PlansResource.d.ts:266

update

update(
    id: string,
    params?: PlanUpdateParams,
    options?: RequestOptions,
): Promise<Response<Stripe.Plan>>
Updates the specified plan by setting the values of the parameters passed. Any parameters not provided are left unchanged. By design, you cannot change a plan's ID, amount, currency, or billing cycle.
Parameters
- id: string
- Optionalparams: PlanUpdateParams
- Optionaloptions: RequestOptions
Returns Promise<Response<Stripe.Plan>>
- Defined in node_modules/stripe/types/PlansResource.d.ts:274

list

list(
params?: PlanListParams,
options?: RequestOptions,
): ApiListPromise<Stripe.Plan>
Returns a list of your plans.
Parameters
- Optionalparams: PlanListParams
- Optionaloptions: RequestOptions
Returns ApiListPromise<Stripe.Plan>
- Defined in node_modules/stripe/types/PlansResource.d.ts:283
list(options?: RequestOptions): ApiListPromise<Stripe.Plan>
Returns a list of your plans.
Parameters
- Optionaloptions: RequestOptions
Returns ApiListPromise<Stripe.Plan>
- Defined in node_modules/stripe/types/PlansResource.d.ts:287

del

del(
    id: string,
    params?: PlanDeleteParams,
    options?: RequestOptions,
): Promise<Response<DeletedPlan>>
Deleting plans means new subscribers can't be added. Existing subscribers aren't affected.
Parameters
- id: string
- Optionalparams: PlanDeleteParams
- Optionaloptions: RequestOptions
Returns Promise<Response<DeletedPlan>>
- Defined in node_modules/stripe/types/PlansResource.d.ts:292
del(id: string, options?: RequestOptions): Promise<Response<DeletedPlan>>
Deleting plans means new subscribers can't be added. Existing subscribers aren't affected.
Parameters
- id: string
- Optionaloptions: RequestOptions
Returns Promise<Response<DeletedPlan>>
- Defined in node_modules/stripe/types/PlansResource.d.ts:297