---
title: "BillingProfilePagePaginatedResponse"
url: "https://nov18-dev.movespot.fyi/apis/konnect-metering-billing-0/versions/1801ac42-b9c2-4bc2-8094-1177df9ed25c/schemas/BillingProfilePagePaginatedResponse"
---

> Full API specification: https://nov18-dev.movespot.fyi/apis/konnect-metering-billing-0/versions/1801ac42-b9c2-4bc2-8094-1177df9ed25c.md

# BillingProfilePagePaginatedResponse

Page paginated response.

## OpenAPI definition

```yaml
openapi: 3.0.0
info:
  title: Konnect Metering & Billing
  version: 0.0.1
servers:
  - url: https://us.api.konghq.com/v3
    description: United-States Production region
  - url: https://eu.api.konghq.com/v3
    description: Europe Production region
  - url: https://au.api.konghq.com/v3
    description: Australia Production region
  - url: https://me.api.konghq.com/v3
    description: Middle-East Production region
  - url: https://in.api.konghq.com/v3
    description: India Production region
  - url: https://sg.api.konghq.com/v3
    description: Singapore Production region
components:
  schemas:
    BillingProfile:
      description: Billing profiles contain the settings for billing and controls
        invoice generation.
      type: object
      properties:
        id:
          description: ULID (Universally Unique Lexicographically Sortable Identifier).
          type: string
          example: 01G65Z755AFWAKHE12NY0CQ9FH
          pattern: ^[0-7][0-9A-HJKMNP-TV-Z]{25}$
          readOnly: true
          title: ULID
        name:
          description: |-
            Display name of the resource.

            Between 1 and 256 characters.
          type: string
          maxLength: 256
          minLength: 1
        description:
          description: |-
            Optional description of the resource.

            Maximum 1024 characters.
          type: string
          maxLength: 1024
        labels:
          $ref: "#/components/schemas/Labels"
        created_at:
          description: An ISO-8601 timestamp representation of entity creation date.
          type: string
          format: date-time
          example: 2023-01-01T01:01:01.001Z
          readOnly: true
          title: RFC3339 Date-Time
        updated_at:
          description: An ISO-8601 timestamp representation of entity last update date.
          type: string
          format: date-time
          example: 2023-01-01T01:01:01.001Z
          readOnly: true
          title: RFC3339 Date-Time
        deleted_at:
          description: An ISO-8601 timestamp representation of entity deletion date.
          type: string
          format: date-time
          example: 2023-01-01T01:01:01.001Z
          readOnly: true
          title: RFC3339 Date-Time
        supplier:
          description: The name and contact information for the supplier this billing
            profile represents
          type: object
          properties:
            id:
              description: Unique identifier for the party.
              type: string
              readOnly: true
            key:
              description: An optional unique key of the party.
              type: string
              example: 019ae40f-4258-7f15-9491-842f42a7d6ac
              maxLength: 256
              minLength: 1
              title: External Resource Key
            name:
              description: Legal name or representation of the party.
              type: string
            tax_id:
              description: >-
                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.
              type: object
              properties:
                code:
                  description: Normalized tax identification code shown on the original identity
                    document.
                  type: string
                  maxLength: 32
                  minLength: 1
            addresses:
              description: Address for where information should be sent if needed.
              type: object
              properties:
                billing_address:
                  description: Billing address.
                  type: object
                  properties:
                    country:
                      description: Country code in [ISO
                        3166-1](https://www.iso.org/iso-3166-country-codes.html)
                        alpha-2 format.
                      type: string
                      example: US
                      maxLength: 2
                      minLength: 2
                      pattern: ^[A-Z]{2}$
                      title: Country
                    postal_code:
                      description: Postal code.
                      type: string
                      title: Postal Code
                    state:
                      description: State or province.
                      type: string
                      title: State
                    city:
                      description: City.
                      type: string
                      title: City
                    line1:
                      description: First line of the address.
                      type: string
                      title: Line 1
                    line2:
                      description: Second line of the address.
                      type: string
                      title: Line 2
                    phone_number:
                      description: Phone number.
                      type: string
                      title: Phone Number
              required:
                - billing_address
        workflow:
          description: The billing workflow settings for this profile
          type: object
          properties:
            collection:
              description: The collection settings for this workflow
              type: object
              properties:
                alignment:
                  description: The alignment for collecting the pending line items into an
                    invoice.
                  type: object
                  default:
                    type: subscription
                  discriminator:
                    propertyName: type
                    mapping:
                      subscription: "#/components/schemas/BillingWorkflowCollectionAlignmentSubscript\
                        ion"
                      anchored: "#/components/schemas/BillingWorkflowCollectionAlignmentAnchored"
                  oneOf:
                    - $ref: "#/components/schemas/BillingWorkflowCollectionAlignmentSubscription"
                    - $ref: "#/components/schemas/BillingWorkflowCollectionAlignmentAnchored"
                interval:
                  description: >-
                    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.
                  type: string
                  format: ISO8601
                  example: P1D
                  default: PT1H
              title: Workflow collection settings
            invoicing:
              description: The invoicing settings for this workflow
              type: object
              properties:
                auto_advance:
                  description: Whether to automatically issue the invoice after the draftPeriod
                    has passed.
                  type: boolean
                  default: true
                draft_period:
                  description: The period for the invoice to be kept in draft status for manual
                    reviews.
                  type: string
                  format: ISO8601
                  example: P1D
                  default: P0D
                progressive_billing:
                  description: Should progressive billing be allowed for this workflow?
                  type: boolean
                  default: true
              title: Workflow invoice settings
            payment:
              description: The payment settings for this workflow
              type: object
              discriminator:
                propertyName: collection_method
                mapping:
                  charge_automatically: "#/components/schemas/BillingWorkflowPaymentChargeAutomat\
                    icallySettings"
                  send_invoice: "#/components/schemas/BillingWorkflowPaymentSendInvoiceSettings"
              oneOf:
                - $ref: "#/components/schemas/BillingWorkflowPaymentChargeAutomaticallySettings"
                - $ref: "#/components/schemas/BillingWorkflowPaymentSendInvoiceSettings"
            tax:
              description: The tax settings for this workflow
              type: object
              properties:
                enabled:
                  description: >-
                    Enable automatic tax calculation when tax is supported by
                    the app.

                    For example, with Stripe Invoicing when enabled, tax is
                    calculated via Stripe Tax.
                  type: boolean
                  default: true
                enforced:
                  description: >-
                    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.
                  type: boolean
                  default: false
                default_tax_config:
                  description: Default tax configuration to apply to the invoices for line items.
                  type: object
                  properties:
                    behavior:
                      description: >-
                        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.
                      type: string
                      enum:
                        - inclusive
                        - exclusive
                      title: Tax behavior
                    stripe:
                      description: Stripe tax config.
                      type: object
                      properties:
                        code:
                          description: Product [tax code](https://docs.stripe.com/tax/tax-codes).
                          type: string
                          example: txcd_10000000
                          pattern: ^txcd_\d{8}$
                          title: Tax code
                      required:
                        - code
                      title: Stripe tax config
                    external_invoicing:
                      description: External invoicing tax config.
                      type: object
                      properties:
                        code:
                          description: The tax code should be interpreted by the external invoicing
                            provider.
                          type: string
                          maxLength: 64
                          title: Tax code
                      required:
                        - code
                      title: External invoicing tax config
              title: Workflow tax settings
        apps:
          description: The applications used by this billing profile.
          type: object
          properties:
            tax:
              description: The tax app used for this workflow.
              type: object
              properties:
                id:
                  description: The ID of the app.
                  type: string
                  example: 01G65Z755AFWAKHE12NY0CQ9FH
                  pattern: ^[0-7][0-9A-HJKMNP-TV-Z]{25}$
                  title: ULID
              required:
                - id
            invoicing:
              description: The invoicing app used for this workflow.
              type: object
              properties:
                id:
                  description: The ID of the app.
                  type: string
                  example: 01G65Z755AFWAKHE12NY0CQ9FH
                  pattern: ^[0-7][0-9A-HJKMNP-TV-Z]{25}$
                  title: ULID
              required:
                - id
            payment:
              description: The payment app used for this workflow.
              type: object
              properties:
                id:
                  description: The ID of the app.
                  type: string
                  example: 01G65Z755AFWAKHE12NY0CQ9FH
                  pattern: ^[0-7][0-9A-HJKMNP-TV-Z]{25}$
                  title: ULID
              required:
                - id
          required:
            - tax
            - invoicing
            - payment
        default:
          description: Whether this is the default profile.
          type: boolean
      required:
        - id
        - name
        - supplier
        - workflow
        - apps
        - default
    PaginatedMeta:
      description: returns the pagination information
      type: object
      properties:
        page:
          $ref: "#/components/schemas/PageMeta"
      required:
        - page
      title: PaginatedMeta
    Labels:
      description: >
        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 "_".
      type: object
      example:
        env: test
      additionalProperties:
        type: string
        pattern: ^[a-z0-9A-Z]{1}([a-z0-9A-Z-._]*[a-z0-9A-Z]+)?$
        minLength: 1
        maxLength: 63
      maxProperties: 50
      title: Labels
    BillingWorkflowCollectionAlignmentSubscription:
      description: >-
        BillingWorkflowCollectionAlignmentSubscription specifies the alignment
        for collecting the pending line items

        into an invoice.
      type: object
      properties:
        type:
          description: The type of alignment.
          type: string
          enum:
            - subscription
      required:
        - type
    BillingWorkflowCollectionAlignmentAnchored:
      description: >-
        BillingWorkflowCollectionAlignmentAnchored specifies the alignment for
        collecting the pending line items

        into an invoice.
      type: object
      properties:
        type:
          description: The type of alignment.
          type: string
          enum:
            - anchored
        recurring_period:
          description: The recurring period for the alignment.
          type: object
          properties:
            anchor:
              description: A date-time anchor to base the recurring period on.
              type: string
              format: date-time
              example: 2023-01-01T01:01:01.001Z
              title: Anchor time
            interval:
              description: The interval duration in ISO 8601 format.
              type: string
              format: ISO8601
              example: P1M
              pattern: ^P(?:\d+(?:\.\d+)?Y)?(?:\d+(?:\.\d+)?M)?(?:\d+(?:\.\d+)?W)?(?:\d+(?:\.\d+)?D)?(?:T(?:\d+(?:\.\d+)?H)?(?:\d+(?:\.\d+)?M)?(?:\d+(?:\.\d+)?S)?)?$
              title: Interval in ISO 8601 duration format
          required:
            - anchor
            - interval
      required:
        - type
        - recurring_period
    BillingWorkflowPaymentChargeAutomaticallySettings:
      description: Payment settings for a billing workflow when the collection method
        is charge automatically.
      type: object
      properties:
        collection_method:
          description: The collection method for the invoice.
          type: string
          enum:
            - charge_automatically
      required:
        - collection_method
    BillingWorkflowPaymentSendInvoiceSettings:
      description: Payment settings for a billing workflow when the collection method
        is send invoice.
      type: object
      properties:
        collection_method:
          description: The collection method for the invoice.
          type: string
          enum:
            - send_invoice
        due_after:
          description: >-
            The period after which the invoice is due.

            With some payment solutions it's only applicable for manual
            collection method.
          type: string
          format: ISO8601
          example: P30D
          default: P30D
      required:
        - collection_method
    PageMeta:
      description: Contains pagination query parameters and the total number of
        objects returned.
      type: object
      properties:
        number:
          type: number
          example: 1
        size:
          type: number
          example: 10
        total:
          type: number
          example: 100
      required:
        - number
        - size
        - total
    BillingProfilePagePaginatedResponse:
      description: Page paginated response.
      type: object
      properties:
        data:
          type: array
          items:
            $ref: "#/components/schemas/BillingProfile"
        meta:
          $ref: "#/components/schemas/PaginatedMeta"
      required:
        - data
        - meta
```
