---
title: "List billing profiles"
method: GET
path: "/v3/openmeter/profiles"
tags: ["OpenMeter Billing Settings"]
---

# List billing profiles

`GET /v3/openmeter/profiles`

List billing profiles.

## Query parameters

- `page` object
  - `size` integer — The number of items to include per page.
  - `number` integer — The page number.

## Response `200`

Page paginated response.

- BillingProfilePagePaginatedResponse — Page paginated response.
  - `data` BillingProfile[], required
    - `id` string, required — ULID (Universally Unique Lexicographically Sortable Identifier).
    - `name` string, required — Display name of the resource. Between 1 and 256 characters.
    - `description` string — Optional description of the resource. Maximum 1024 characters.
    - `labels` Labels — Labels store metadata of an entity that can be used for filtering an entity list or for searching across entity types. Keys must be of length 1-63 characters, and cannot start with "kong", "konnect", "mesh", "kic", or "_".
    - `created_at` string, date-time, required — An ISO-8601 timestamp representation of entity creation date.
    - `updated_at` string, date-time, required — An ISO-8601 timestamp representation of entity last update date.
    - `deleted_at` string, date-time — An ISO-8601 timestamp representation of entity deletion date.
    - `supplier` object, required — The name and contact information for the supplier this billing profile represents
      - `id` string — Unique identifier for the party.
      - `key` string — An optional unique key of the party.
      - `name` string — Legal name or representation of the party.
      - `tax_id` object — The entity's legal identification used for tax purposes. They may have other numbers, but we're only interested in those valid for tax purposes.
        - `code` string — Normalized tax identification code shown on the original identity document.
      - `addresses` object — Address for where information should be sent if needed.
        - `billing_address` object, required — Billing address.
          - `country` string — Country code in [ISO 3166-1](https://www.iso.org/iso-3166-country-codes.html) alpha-2 format.
          - `postal_code` string — Postal code.
          - `state` string — State or province.
          - `city` string — City.
          - `line1` string — First line of the address.
          - `line2` string — Second line of the address.
          - `phone_number` string — Phone number.
    - `workflow` object, required — The billing workflow settings for this profile
      - `collection` object — The collection settings for this workflow
        - `alignment` union — The alignment for collecting the pending line items into an invoice.
          - object — BillingWorkflowCollectionAlignmentSubscription specifies the alignment for collecting the pending line items into an invoice.
            - `type` 'subscription', required — The type of alignment.
          - object — BillingWorkflowCollectionAlignmentAnchored specifies the alignment for collecting the pending line items into an invoice.
            - `type` 'anchored', required — The type of alignment.
            - `recurring_period` object, required — The recurring period for the alignment.
              - …
        - `interval` string, ISO8601 — This grace period can be used to delay the collection of the pending line items specified in alignment. This is useful, in case of multiple subscriptions having slightly different billing periods.
      - `invoicing` object — The invoicing settings for this workflow
        - `auto_advance` boolean — Whether to automatically issue the invoice after the draftPeriod has passed.
        - `draft_period` string, ISO8601 — The period for the invoice to be kept in draft status for manual reviews.
        - `progressive_billing` boolean — Should progressive billing be allowed for this workflow?
        - `subscription_end_proration_mode` 'bill_full_period' | 'bill_actual_period' — Controls how subscription-ending shortened service periods are billed.
      - `payment` union — The payment settings for this workflow
        - object — Payment settings for a billing workflow when the collection method is charge automatically.
          - `collection_method` 'charge_automatically', required — The collection method for the invoice.
        - object — Payment settings for a billing workflow when the collection method is send invoice.
          - `collection_method` 'send_invoice', required — The collection method for the invoice.
          - `due_after` string, ISO8601 — The period after which the invoice is due. With some payment solutions it's only applicable for manual collection method.
      - `tax` object — The tax settings for this workflow
        - `enabled` boolean — Enable automatic tax calculation when tax is supported by the app. For example, with Stripe Invoicing when enabled, tax is calculated via Stripe Tax.
        - `enforced` boolean — Enforce tax calculation when tax is supported by the app. When enabled, the billing system will not allow to create an invoice without tax calculation. Enforcement is different per apps, for example, Stripe app requires customer to have a tax location when starting a paid subscription.
        - `default_tax_config` object — Default tax configuration to apply to the invoices for line items. Setting a tax code (`stripe.code` / `taxCodeId`) on a profile's default tax config is deprecated and can no longer be added or changed: the organization default tax code is used instead. Existing tax-code values may still be removed, and `behavior` remains fully supported.
          - `behavior` 'inclusive' | 'exclusive' — Tax behavior. If not specified the billing profile is used to determine the tax behavior. If not specified in the billing profile, the provider's default behavior is used.
          - `stripe` object — Stripe tax config.
            - `code` string, required — Product [tax code](https://docs.stripe.com/tax/tax-codes).
          - `external_invoicing` object — External invoicing tax config.
            - `code` string, required — The tax code should be interpreted by the external invoicing provider.
          - `tax_code_id` string — Tax code ID.
          - `tax_code` object — Tax code reference. When both `tax_code` and `tax_code_id` are provided, `tax_code` takes precedence. When `stripe.code` is also provided, `tax_code` still wins and `stripe.code` is ignored.
            - `id` string, required — ULID (Universally Unique Lexicographically Sortable Identifier).
    - `apps` object, required — The applications used by this billing profile.
      - `tax` object, required — The tax app used for this workflow.
        - `id` string, required — The ID of the app.
      - `invoicing` object, required — The invoicing app used for this workflow.
        - `id` string, required — The ID of the app.
      - `payment` object, required — The payment app used for this workflow.
        - `id` string, required — The ID of the app.
    - `default` boolean, required — Whether this is the default profile.
  - `meta` PaginatedMeta, required — returns the pagination information
    - `page` PageMeta, required — Contains pagination query parameters and the total number of objects returned.
      - `number` number, required
      - `size` number, required
      - `total` number, required

## Other responses

- `400` — Bad Request
- `401` — Unauthorized
- `403` — Forbidden

---

[API](https://skmtc.net/kong/apis/konnect-api-go-sdk.md) · [All operations](https://skmtc.net/kong/apis/konnect-api-go-sdk/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/kong/konnect-api-go-sdk/versions/f920f418f552/schema)