getPlan( )

Retrieves a pricing plan by the specified ID.

The getPlan() function returns a Promise that resolves to a plan whose ID matched the specified ID.

Admin Method

This function requires elevated permissions and runs only on the backend and on dashboard pages.

Permission Scopes

For app development, you must have one of the following permission scopes:
Read Pricing Plans
Manage Pricing Plans
Learn more about permission scopes.
Method Declaration
Method Parameters

Plan ID.

Return Type:Promise<Plan>
Was this helpful?