Class Plans

getAll

• getAll(options?: { PlanFamily?: Required<Pick<PlanFamily, "Uid">>; limit?: number; offset?: number }): Promise<List<Plan>>

• Get all available plans.

  const client = new OutsetaApiClient({ subdomain: 'test-company' });
  const response = await client.billing.plans.getAll();
  console.log(response);
  

  throws

  Response If the server returns a non-"OK" status, the whole response object will be thrown.

  Parameters

  • options: { PlanFamily?: Required<Pick<PlanFamily, "Uid">>; limit?: number; offset?: number } = {}

    • Optional PlanFamily?: Required<Pick<PlanFamily, "Uid">>

      Get all plans that belong to a specific plan family.

    • Optional limit?: number

      The number of results returned by the API.

    • Optional offset?: number

      For pagination; returns (limit) results after this value.

  Returns Promise<List<Plan>>

  The response body.