Chargebee Payment Schedules API

openapi: 3.2.0
info:
  title: Chargebee Payment Schedules API
  contact:
    name: Chargebee Support
    url: https://www.chargebee.com
    email: support@chargebee.com
  version: 2026-09-24.553c79154f0075cfbab35271eeff8b63a3ed6a86
  x-cb-product-catalog-version: 2
  x-cb-api-version: 2
servers:
- url: '{protocol}://{site}.{environment}:{port}/api/v2'
  variables:
    protocol:
      default: https
      enum:
      - https
    site:
      default: demo
    environment:
      default: chargebee.com
      enum:
      - chargebee.com
    port:
      default: '443'
      enum:
      - '443'
- url: '{protocol}://{site}-test.{environment}:{port}/api/v2'
  variables:
    protocol:
      default: https
      enum:
      - https
    site:
      default: demo
    environment:
      default: chargebee.com
      enum:
      - chargebee.com
    port:
      default: '443'
      enum:
      - '443'
tags:
- name: Payment Schedules
paths:
  /payment_schedules:
    get:
      summary: List payment schedules
      operationId: list_payment_schedules
      parameters:
      - description: The device from which the customer has made the request
        $ref: '#/components/parameters/chargebee-request-origin-device'
      - description: The email address of your customer/user. Use this when the email address has only ASCII characters.
        $ref: '#/components/parameters/chargebee-request-origin-user'
      - description: The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.
        $ref: '#/components/parameters/chargebee-request-origin-user-encoded'
      - description: The IP address of the customer where the request originated
        $ref: '#/components/parameters/chargebee-request-origin-ip'
      - description: If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.
        $ref: '#/components/parameters/chargebee-business-entity-id'
      - $ref: '#/components/parameters/limit'
      - $ref: '#/components/parameters/offset'
      - name: invoice_id
        in: query
        required: false
        deprecated: false
        style: deepObject
        explode: true
        schema:
          type: object
          deprecated: false
          description: Unique identifier of the invoice
          example: INV-001
          x-cb-parameter-blank-option: as_null
          x-cb-attribute-meta-comment: optional
          x-cb-is-multi-value-attribute: true
          x-cb-is-filter-parameter: true
          x-cb-is-api-column: true
          x-cb-sdk-filter-name: StringFilter
          x-cb-sort-order: 2
          properties:
            is:
              type: string
              minLength: 1
              example: null
            is_not:
              type: string
              minLength: 1
              example: null
            starts_with:
              type: string
              minLength: 1
              example: null
            in:
              type: string
              pattern: ^\[(.*)(,.*)*\]$
              example: null
            not_in:
              type: string
              pattern: ^\[(.*)(,.*)*\]$
              example: null
      - name: id
        in: query
        required: false
        deprecated: false
        style: deepObject
        explode: true
        schema:
          type: object
          deprecated: false
          description: An auto-generated unique identifier for the payment schedule.
          example: ps_123
          x-cb-parameter-blank-option: not_allowed
          x-cb-attribute-meta-comment: optional
          x-cb-is-multi-value-attribute: true
          x-cb-is-filter-parameter: true
          x-cb-meta-model-name: payment_schedules
          x-cb-is-api-column: true
          x-cb-sdk-filter-name: StringFilter
          x-cb-sort-order: 3
          properties:
            is:
              type: string
              minLength: 1
              example: null
            is_not:
              type: string
              minLength: 1
              example: null
            starts_with:
              type: string
              minLength: 1
              example: null
            in:
              type: string
              pattern: ^\[(.*)(,.*)*\]$
              example: null
            not_in:
              type: string
              pattern: ^\[(.*)(,.*)*\]$
              example: null
      - name: updated_at
        in: query
        required: false
        deprecated: false
        style: deepObject
        explode: true
        schema:
          type: object
          deprecated: false
          description: Specifies when these payment schedules are updated recently.
          example: '1435054328'
          x-cb-parameter-blank-option: as_null
          x-cb-attribute-meta-comment: optional
          x-cb-is-filter-parameter: true
          x-cb-meta-model-name: payment_schedules
          x-cb-is-api-column: true
          x-cb-sdk-filter-name: TimestampFilter
          x-cb-is-multi-value-attribute: false
          x-cb-sort-order: 4
          properties:
            after:
              type: string
              format: unix-time
              pattern: ^\d{10}$
              example: null
            before:
              type: string
              format: unix-time
              pattern: ^\d{10}$
              example: null
            'on':
              type: string
              format: unix-time
              pattern: ^\d{10}$
              example: null
            between:
              type: string
              pattern: ^\[\d{10},\d{10}\]$
              example: null
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  list:
                    type: array
                    items:
                      type: object
                      properties:
                        payment_schedule:
                          $ref: '#/components/schemas/PaymentSchedule'
                          description: Resource object representing payment_schedule
                      required:
                      - payment_schedule
                      example: null
                    example: null
                  next_offset:
                    type: string
                    description: This attribute is returned only if more resources are present. To fetch the next set of resources use this value for the input parameter `offset`.
                    maxLength: 1000
                    example: null
                required:
                - list
                example: null
        '400':
          description: on error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/400'
        '401':
          description: on error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/401'
        '403':
          description: on error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/403'
        '404':
          description: on error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/404'
        '405':
          description: on error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/405'
        '409':
          description: on error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/409'
        '422':
          description: on error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/422'
        '429':
          description: on error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/429'
        '500':
          description: on error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/500'
        '503':
          description: on error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/503'
      deprecated: false
      security:
      - BasicAuth: []
      x-cb-resource-id: payment_schedule
      x-cb-sort-order: 0
      x-cb-module: invoice
      x-cb-operation-is-list: true
      x-cb-operation-method-name: list
      x-cb-is-operation-needs-input-object: true
      x-cb-sdk-method-name: list
      tags:
      - Payment Schedules
components:
  schemas:
    '400':
      type: object
      properties:
        message:
          type: string
          example: null
        param:
          type: string
          example: null
        type:
          type: string
          enum:
          - invalid_request
          - untyped
          - payment
          example: null
        api_error_code:
          type: string
          description: '* `payment_intent_invalid_amount` - Returned when processing amount is different from payment intent amountFor example if payment intent which is passed has authorized 10$ and if the charges initiated is for 12$.

            * `configuration_incompatible` - Returned when the request is not compatible with the configuration for the  site or the configuration is incomplete.

            * `payment_intent_invalid` - Returned when validation or verification fails for provided payment intent.For example if payment intent which is passed is in not consumable state.

            * `invalid_request` - Returned when the request has incompatible values or does not match the API specification. As it is a generic error, handling this error is recommended only in combination  with  param attribute.

            * `payment_method_verification_failed` - Returned when validation or verification fails for the provided payment method. For example  if the payment method is card, this will include all card parameter validation errors and also verification failures  from the gateway.

            * `payment_processing_failed` - Returned when the payment collection fails.

            * `resource_limit_exhausted` - Returned when any limit constraint is violated by the request. For example this error is  thrown when the coupon provided has already expired or its maximum redemption count has been reached.

            * `duplicate_entry` - Returned when the request provides a duplicate value for an attribute that is specified as unique for that site.  For example in ''create subscription api'' if you are passing  the subscription id then this error will be thrown if a subscription exists in site with the same id.

            * `param_wrong_value` - Returned when the value does not meet the required specification for the parameter. For example, wrong email format. It is strongly recommended  to do the validation at your end before calling Chargebee''s API (other than specific cases like  VAT number validation).

            * `payment_method_not_present` - Returned when the request requires payment collection but the ''payment method'' details (such as card) is not present for the customer. This error will not occur if auto-collection is disabled for the customer.

            * `resource_limit_exceeded`

            * `payment_gateway_currency_incompatible` - Returned when the payment gateway configured is incompatible with the transactional currency. This error will not occur if auto-collection is disabled for the customer.'
          enum:
          - payment_intent_invalid_amount
          - configuration_incompatible
          - payment_intent_invalid
          - invalid_request
          - payment_method_verification_failed
          - payment_processing_failed
          - resource_limit_exhausted
          - duplicate_entry
          - param_wrong_value
          - payment_method_not_present
          - resource_limit_exceeded
          - payment_gateway_currency_incompatible
          example: null
      required:
      - api_error_code
      - message
      - type
      example: null
    '422':
      type: object
      properties:
        message:
          type: string
          example: null
        param:
          type: string
          example: null
        type:
          type: string
          enum:
          - invalid_request
          example: null
        api_error_code:
          type: string
          description: '* `unable_to_process_request` - Returned when the HTTP request body contains a well-formed, but semantically erroneous payload. For example this error is returned when a client attempts to reuse an idempotency key with a different request payload.'
          enum:
          - unable_to_process_request
          example: null
      required:
      - api_error_code
      - message
      - type
      example: null
    '404':
      type: object
      properties:
        message:
          type: string
          example: null
        param:
          type: string
          example: null
        type:
          type: string
          enum:
          - invalid_request
          - untyped
          example: null
        api_error_code:
          type: string
          description: "* `resource_not_found` - Returned when any of resource(s) referred in the request is not found. \n* `site_not_found` - Returned when the site is not found."
          enum:
          - resource_not_found
          - site_not_found
          example: null
      required:
      - api_error_code
      - message
      - type
      example: null
    '503':
      type: object
      properties:
        message:
          type: string
          example: null
        param:
          type: string
          example: null
        type:
          type: string
          enum:
          - invalid_request
          - operation_failed
          example: null
        api_error_code:
          type: string
          description: '* `db_connection_failure` - Returned when db connection fails.

            * `site_read_only_mode` - Returned when your site is temporarily unavailable for write operations due to a scheduled maintenance.

            * `site_not_ready` - Returned when your site is temporarily unavailable due to a scheduled maintenance.

            * `internal_temporary_error` - Returned when temporary occured in Chargebee side. The request can be re-tried, with exponential backoff in case of repeat failures.'
          enum:
          - db_connection_failure
          - site_read_only_mode
          - site_not_ready
          - internal_temporary_error
          example: null
      required:
      - api_error_code
      - message
      - type
      example: null
    '401':
      type: object
      properties:
        message:
          type: string
          example: null
        param:
          type: string
          example: null
        type:
          type: string
          enum:
          - untyped
          example: null
        api_error_code:
          type: string
          description: '* `api_authentication_failed` - Returned when authentication failed for the request. The possible reasons could be the api key is invalid or authentication header is not present in the request or the header''s format is invalid.

            * `basic_authentication_failed` - Returned when authentication failed for the request. The possible reasons could be that one or both of the username and password are invalid'
          enum:
          - api_authentication_failed
          - basic_authentication_failed
          example: null
      required:
      - api_error_code
      - message
      - type
      example: null
    '403':
      type: object
      properties:
        message:
          type: string
          example: null
        param:
          type: string
          example: null
        type:
          type: string
          enum:
          - untyped
          - operation_failed
          example: null
        api_error_code:
          type: string
          description: '* `request_blocked` - Returned when request is blocked for your site. The blocking could be only for a specific set of operation(s) . The reason would be provided as part of the message. You would have to contact support for additional details.

            * `api_authorization_failed` - Returned when the API key does not have sufficient privileges to perform the particular operation.'
          enum:
          - request_blocked
          - api_authorization_failed
          example: null
      required:
      - api_error_code
      - message
      - type
      example: null
    '500':
      type: object
      properties:
        message:
          type: string
          example: null
        param:
          type: string
          example: null
        type:
          type: string
          enum:
          - operation_failed
          example: null
        api_error_code:
          type: string
          description: '* `internal_error` - Returned when the request parameters were right but the operation couldn''t be completed due to a bug in Chargebee side.'
          enum:
          - internal_error
          example: null
      required:
      - api_error_code
      - message
      - type
      example: null
    PaymentSchedule:
      type: object
      x-cb-resource-id: payment_schedule
      x-cb-resource-path-name: payment_schedules
      x-cb-is-dependent-resource: false
      x-cb-sort-order: 25
      properties:
        id:
          type: string
          deprecated: false
          x-cb-sort-order: 0
          maxLength: 40
          example: null
        scheme_id:
          type: string
          deprecated: false
          x-cb-sort-order: 1
          maxLength: 40
          example: null
        entity_type:
          type: string
          deprecated: false
          enum:
          - invoice
          x-cb-is-global-enum: false
          x-cb-is-api-column: true
          x-cb-is-external-enum: false
          x-cb-is-gen-separate: false
          x-cb-is-ignore-generation: false
          x-cb-sdk-enum-api-name: EntityType
          x-cb-sort-order: 2
          example: null
        entity_id:
          type: string
          deprecated: false
          x-cb-sort-order: 3
          maxLength: 50
          example: null
        amount:
          type: integer
          format: int64
          deprecated: false
          x-cb-is-money-column: true
          x-cb-is-long-money-column: true
          x-cb-sort-order: 4
          minimum: 0
          example: null
        created_at:
          type: integer
          format: unix-time
          deprecated: false
          x-cb-sort-order: 5
          example: null
        resource_version:
          type: integer
          format: int64
          deprecated: false
          x-cb-sort-order: 6
          example: null
        updated_at:
          type: integer
          format: unix-time
          deprecated: false
          x-cb-sort-order: 7
          example: null
        currency_code:
          type: string
          deprecated: false
          x-cb-sort-order: 8
          maxLength: 3
          example: null
        schedule_entries:
          type: array
          deprecated: false
          x-cb-sort-order: 9
          items:
            type: object
            deprecated: false
            x-cb-is-sub-resource: true
            x-cb-sub-resource-name: ScheduleEntry
            x-cb-sub-resource-parent-name: PaymentSchedule
            properties:
              id:
                type: string
                deprecated: false
                maxLength: 40
                example: null
              date:
                type: integer
                format: unix-time
                deprecated: false
                example: null
              amount:
                type: integer
                format: int64
                deprecated: false
                x-cb-is-money-column: true
                x-cb-is-long-money-column: true
                minimum: 0
                example: null
              scheduled_amount:
                type: integer
                format: int64
                deprecated: false
                x-cb-is-money-column: true
                x-cb-is-long-money-column: true
                minimum: 0
                example: null
              status:
                type: string
                deprecated: false
                enum:
                - posted
                - payment_due
                - paid
                x-cb-is-global-enum: false
                x-cb-is-api-column: true
                x-cb-is-external-enum: false
                x-cb-is-gen-separate: false
                x-cb-is-ignore-generation: false
                x-cb-sdk-enum-api-name: Status
                example: null
            required:
            - amount
            - date
            - id
            - scheduled_amount
            - status
            example: null
          example: null
        reference_transactions:
          type: array
          deprecated: false
          x-cb-sort-order: 10
          items:
            type: object
            deprecated: false
            x-cb-is-sub-resource: true
            x-cb-sub-resource-name: ScheduleEntryTransaction
            x-cb-sub-resource-parent-name: PaymentSchedule
            properties:
              schedule_entry_id:
                type: string
                deprecated: false
                x-cb-is-foreign-column: true
                maxLength: 40
                example: null
              applied_amount:
                type: integer
                format: int64
                deprecated: false
                x-cb-is-money-column: true
                x-cb-is-long-money-column: true
                minimum: 0
                example: null
              txn_id:
                type: string
                deprecated: false
                maxLength: 40
                example: null
              txn_status:
                type: string
                deprecated: false
                enum:
                - in_progress
                - success
                - voided
                - failure
                - timeout
                - needs_attention
                - late_failure
                x-cb-is-global-enum: false
                x-cb-is-api-column: true
                x-cb-is-external-enum: true
                x-cb-is-gen-separate: false
                x-cb-is-ignore-generation: false
                x-cb-sdk-enum-api-name: Transaction.Status
                example: null
              txn_date:
                type: integer
                format: unix-time
                deprecated: false
                example: null
              txn_amount:
                type: integer
                format: int64
                deprecated: false
                x-cb-is-money-column: true
                minimum: 0
                example: null
            required:
            - schedule_entry_id
            - txn_id
            example: null
          example: null
      required:
      - created_at
      - entity_id
      - entity_type
      - id
      - scheme_id
      example: null
    '405':
      type: object
      properties:
        message:
          type: string
          example: null
        param:
          type: string
          example: null
        type:
          type: string
          enum:
          - invalid_request
          example: null
        api_error_code:
          type: string
          description: '* `http_method_not_supported` - Returned when the ''http method'', specified in the request, is not allowed for this URL. It should not occur if you are using one of the standard client library.'
          enum:
          - http_method_not_supported
          example: null
      required:
      - api_error_code
      - message
      - type
      example: null
    '429':
      type: object
      properties:
        message:
          type: string
          example: null
        param:
          type: string
          example: null
        type:
          type: string
          enum:
          - operation_failed
          example: null
        api_error_code:
          type: string
          description: '* `third_party_api_request_limit_exceeded` - Returned when your request is blocked temporarily at a third-party service, due to the request count exceeding their acceptable limits.

            * `api_request_limit_exceeded` - Returned when requests have been blocked temporarily due to request count exceeding acceptable limits.

            * `lock_timeout` - Returned when there are multiple concurrent requests to the same resource.'
          enum:
          - third_party_api_request_limit_exceeded
          - api_request_limit_exceeded
          - lock_timeout
          example: null
      required:
      - api_error_code
      - message
      - type
      example: null
    '409':
      type: object
      properties:
        message:
          type: string
          example: null
        param:
          type: string
          example: null
        type:
          type: string
          enum:
          - invalid_request
          example: null
        api_error_code:
          type: string
          description: '* `invalid_state_for_request` - Returned when the requested operation is not allowed for current state of the resource. This error will occur if the state of the resource has not been checked for the validity of the request. For example this error is returned when we try to schedule subscription changes  at ''end of term'' for canceled subscriptions.'
          enum:
          - invalid_state_for_request
          example: null
      required:
      - api_error_code
      - message
      - type
      example: null
  parameters:
    limit:
      name: limit
      in: query
      required: false
      style: form
      explode: true
      schema:
        type: integer
        format: int32
        default: 10
        description: The number of resources to be returned.
        x-cb-is-pagination-parameter: true
        maximum: 100
        minimum: 1
    chargebee-request-origin-user-encoded:
      name: chargebee-request-origin-user-encoded
      in: header
      description: The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.
      required: false
      style: simple
      explode: false
      schema:
        type: string
        format: email
        description: The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.
        example: dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t
    chargebee-request-origin-user:
      name: chargebee-request-origin-user
      in: header
      description: The email address of your customer/user. Use this when the email address has only ASCII characters.
      required: false
      style: simple
      explode: false
      schema:
        type: string
        format: email
        description: The email address of your customer/user. Use this when the email address has only ASCII characters.
        example: user@example.com
    chargebee-request-origin-device:
      name: chargebee-request-origin-device
      in: header
      description: The device from which the customer has made the request
      required: false
      style: simple
      explode: false
      schema:
        type: string
        description: The device from which the customer has made the request
        example: Android
    chargebee-business-entity-id:
      name: chargebee-business-entity-id
      in: header
      description: If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.
      required: false
      style: simple
      explode: false
      schema:
        type: string
        description: If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.
        maxLength: 50
    chargebee-request-origin-ip:
      name: chargebee-request-origin-ip
      in: header
      description: The IP address of the customer where the request originated
      required: false
      style: simple
      explode: false
      schema:
        type: string
        description: The IP address of the customer where the request originated
        example: 192.168.1.2
        pattern: ^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\-]*[a-fA-F0-9])\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$
    offset:
      name: offset
      in: query
      required: false
      style: form
      explode: true
      schema:
        type: string
        description: Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set 'offset' to the value of 'next_offset' obtained in the previous iteration of the API call.
        x-cb-is-pagination-parameter: true
        maxLength: 1000
  securitySchemes:
    BasicAuth:
      type: http
      scheme: basic
x-provenance:
  method: harvested
  publisher: Chargebee
  source: https://raw.githubusercontent.com/chargebee/openapi/HEAD/spec/chargebee_sdk_spec.json
  note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
    stamped by stamp-openapi-provenance.py (roadmap#793)