Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

  • PlanFamilies

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

Private Readonly store

store: Store

Methods

getAll

  • getAll(options?: { limit?: number; offset?: number }): Promise<List<PlanFamily>>
  • Get all available plan families.

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

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

    Parameters

    • options: { limit?: number; offset?: number } = {}
      • 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<PlanFamily>>

    The response body.

Generated using TypeDoc