---
title: "POST /list-billing-groups"
method: POST
path: "/list-billing-groups"
---

# POST /list-billing-groups

`POST /list-billing-groups`

A paginated call to retrieve a list of billing groups for the given billing period. If you don't provide a billing group, the current billing period is used.

## Request body

- object
  - `BillingPeriod` string — The preferred billing period to get billing groups.
  - `MaxResults` integer — The maximum number of billing groups to retrieve.
  - `NextToken` string — The pagination token that's used on subsequent calls to get billing groups.
  - `Filters` object — The filter that specifies the billing groups and pricing plans to retrieve billing group information.
    - `Arns` BillingGroupArn[] — The list of billing group Amazon Resource Names (ARNs) to retrieve information.
    - `PricingPlan` string — The pricing plan Amazon Resource Names (ARNs) to retrieve information.
    - `Statuses` BillingGroupStatus[] — A list of billing groups to retrieve their current status for a specific time range
    - `AutoAssociate` boolean — Specifies if this billing group will automatically associate newly added Amazon Web Services accounts that join your consolidated billing family.
    - `PrimaryAccountIds` AccountId[] — A list of primary account IDs to filter the billing groups.
    - `BillingGroupTypes` BillingGroupType[] — Filter billing groups by their type.
    - `Names` StringSearch[] — Filter billing groups by their names.
      - `SearchOption` 'STARTS_WITH', required — The search option to be applied when performing the string search.
      - `SearchValue` string, required — The value to search for within the specified string field.
    - `ResponsibilityTransferArns` ResponsibilityTransferArn[] — Filter billing groups by their responsibility transfer ARNs.

## Response `200`

Success

- ListBillingGroupsOutput
  - `BillingGroups` BillingGroupListElement[] — A list of <code>BillingGroupListElement</code> retrieved.
    - `Name` string, password — The name of the billing group.
    - `Arn` string — The Amazon Resource Number (ARN) that can be used to uniquely identify the billing group.
    - `Description` string, password — The description of the billing group.
    - `PrimaryAccountId` string — The account ID that serves as the main account in a billing group.
    - `ComputationPreference` ComputationPreference — The preferences and settings that will be used to compute the Amazon Web Services charges for a billing group.
      - `PricingPlanArn` string, required — The Amazon Resource Name (ARN) of the pricing plan that's used to compute the Amazon Web Services charges for a billing group.
    - `Size` integer — The number of accounts in the particular billing group.
    - `CreationTime` integer — The time when the billing group was created.
    - `LastModifiedTime` integer — The most recent time when the billing group was modified.
    - `Status` 'ACTIVE' | 'PRIMARY_ACCOUNT_MISSING' | 'PENDING' — The billing group status. Only one of the valid values can be used.
    - `StatusReason` string — The reason why the billing group is in its current status.
    - `AccountGrouping` object — Specifies if the billing group has automatic account association (<code>AutoAssociate</code>) enabled.
      - `AutoAssociate` boolean — Specifies if this billing group will automatically associate newly added Amazon Web Services accounts that join your consolidated billing family.
      - `ResponsibilityTransferArn` string — The Amazon Resource Name (ARN) that identifies the transfer relationship for the billing group.
    - `BillingGroupType` 'STANDARD' | 'TRANSFER_BILLING' — The type of billing group.
  - `NextToken` string — The pagination token that's used on subsequent calls to get billing groups.

## Other responses

- `480` — ThrottlingException
- `481` — AccessDeniedException
- `482` — ValidationException
- `483` — InternalServerException
- `484` — ResourceNotFoundException

---

[API](https://skmtc.net/aws/apis/billingconductor.md) · [All operations](https://skmtc.net/aws/apis/billingconductor/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/aws/billingconductor/versions/2cc5849dea95/schema)