v10

latestOpenAPI 3.0.1raw.githubusercontent.com2025-12-033223581.2 MB
AccountPlan

List AccountPlan

Retrieves a list of AccountPlan and AccountPlanGroup entities for the specified Organization. The list can be paginated for easier management, and supports filtering with various query parameters.

get/organizations/{orgId}/accountplans

Path parameters

orgIdstring required

The unique identifier (UUID) of your Organization. The Organization represents your company as a direct customer of our service.

Query parameters

pageSizeinteger

The maximum number of AccountPlans and AccountPlanGroups to return per page.

nextTokenstring

The nextToken for retrieving the next page of AccountPlans and AccountPlanGroups. It is used to fetch the next page of AccountPlans and AccountPlanGroups in a paginated list.

datestring

The specific date for which you want to retrieve AccountPlans and AccountPlanGroups.

NOTE: Returns both active and inactive AccountPlans and AccountPlanGroups for the specified date.

accountstring

The unique identifier (UUID) for the Account whose AccountPlans and AccountPlanGroups you want to retrieve.

NOTE: Only returns the currently active AccountPlans and AccountPlanGroups for the specified Account. Use in combination with the includeall query parameter to return both active and inactive.

planstring

The unique identifier (UUID) for the Plan whose associated AccountPlans you want to retrieve.

NOTE: Does not return AccountPlanGroups if you use a planGroupId.

productstring

The unique identifier (UUID) for the Product whose associated AccountPlans you want to retrieve.

NOTE: You cannot use the product query parameter as a single filter condition, but must always use it in combination with the account query parameter.

includeallboolean

A Boolean flag that specifies whether to include both active and inactive AccountPlans and AccountPlanGroups in the list.

  • TRUE - both active and inactive AccountPlans and AccountPlanGroups are included in the list.
  • FALSE - only active AccountPlans and AccountPlanGroups are retrieved in the list.
idsstring[]

A list of unique identifiers (UUIDs) for specific AccountPlans and AccountPlanGroups you want to retrieve.

contractstring nullable

The unique identifier (UUID) of the Contract which the AccountPlans you want to retrieve have been linked to.

NOTE: Does not return AccountPlanGroups that have been linked to the Contract.

Response

Returns the list of AccountPlans and AccountPlanGroups

nextTokenstring